blob: 94baee63b0e4462b37b6b369439c791529c71925 [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
Charles Saternosb040fcc2018-02-19 15:14:50 +000053static cl::opt<bool>
54 DumpThinCGSCCs("dump-thin-cg-sccs", cl::init(false), cl::Hidden,
55 cl::desc("Dump the SCCs in the ThinLTO index's callgraph"));
56
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000057// The values are (type identifier, summary) pairs.
58typedef DenseMap<
59 GlobalValue::GUID,
60 TinyPtrVector<const std::pair<const std::string, TypeIdSummary> *>>
61 TypeIdSummariesByGuidTy;
62
Mehdi Aminiadc0e262016-08-23 21:30:12 +000063// Returns a unique hash for the Module considering the current list of
64// export/import and other global analysis results.
65// The hash is produced in \p Key.
66static void computeCacheKey(
Peter Collingbournef4257522016-12-08 05:28:30 +000067 SmallString<40> &Key, const Config &Conf, const ModuleSummaryIndex &Index,
68 StringRef ModuleID, const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +000069 const FunctionImporter::ExportSetTy &ExportList,
70 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000071 const GVSummaryMapTy &DefinedGlobals,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +000072 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid,
73 const std::set<GlobalValue::GUID> &CfiFunctionDefs,
74 const std::set<GlobalValue::GUID> &CfiFunctionDecls) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +000075 // Compute the unique hash for this entry.
76 // This is based on the current compiler version, the module itself, the
77 // export list, the hash for every single module in the import list, the
78 // list of ResolvedODR for the module, and the list of preserved symbols.
79 SHA1 Hasher;
80
81 // Start with the compiler revision
82 Hasher.update(LLVM_VERSION_STRING);
Peter Collingbourne942fa562017-04-13 01:26:12 +000083#ifdef LLVM_REVISION
Mehdi Aminiadc0e262016-08-23 21:30:12 +000084 Hasher.update(LLVM_REVISION);
85#endif
86
Peter Collingbournef4257522016-12-08 05:28:30 +000087 // Include the parts of the LTO configuration that affect code generation.
88 auto AddString = [&](StringRef Str) {
89 Hasher.update(Str);
90 Hasher.update(ArrayRef<uint8_t>{0});
91 };
92 auto AddUnsigned = [&](unsigned I) {
93 uint8_t Data[4];
94 Data[0] = I;
95 Data[1] = I >> 8;
96 Data[2] = I >> 16;
97 Data[3] = I >> 24;
98 Hasher.update(ArrayRef<uint8_t>{Data, 4});
99 };
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000100 auto AddUint64 = [&](uint64_t I) {
101 uint8_t Data[8];
102 Data[0] = I;
103 Data[1] = I >> 8;
104 Data[2] = I >> 16;
105 Data[3] = I >> 24;
106 Data[4] = I >> 32;
107 Data[5] = I >> 40;
108 Data[6] = I >> 48;
109 Data[7] = I >> 56;
110 Hasher.update(ArrayRef<uint8_t>{Data, 8});
111 };
Peter Collingbournef4257522016-12-08 05:28:30 +0000112 AddString(Conf.CPU);
113 // FIXME: Hash more of Options. For now all clients initialize Options from
114 // command-line flags (which is unsupported in production), but may set
115 // RelaxELFRelocations. The clang driver can also pass FunctionSections,
116 // DataSections and DebuggerTuning via command line flags.
117 AddUnsigned(Conf.Options.RelaxELFRelocations);
118 AddUnsigned(Conf.Options.FunctionSections);
119 AddUnsigned(Conf.Options.DataSections);
120 AddUnsigned((unsigned)Conf.Options.DebuggerTuning);
121 for (auto &A : Conf.MAttrs)
122 AddString(A);
Evgeniy Stepanovb9f1b012017-05-22 21:11:35 +0000123 if (Conf.RelocModel)
124 AddUnsigned(*Conf.RelocModel);
125 else
126 AddUnsigned(-1);
Rafael Espindola79e238a2017-08-03 02:16:21 +0000127 if (Conf.CodeModel)
128 AddUnsigned(*Conf.CodeModel);
129 else
130 AddUnsigned(-1);
Peter Collingbournef4257522016-12-08 05:28:30 +0000131 AddUnsigned(Conf.CGOptLevel);
Tobias Edler von Kochf454b9e2017-02-15 20:36:36 +0000132 AddUnsigned(Conf.CGFileType);
Peter Collingbournef4257522016-12-08 05:28:30 +0000133 AddUnsigned(Conf.OptLevel);
Tim Shen4e912aa2017-06-01 23:13:44 +0000134 AddUnsigned(Conf.UseNewPM);
Peter Collingbournef4257522016-12-08 05:28:30 +0000135 AddString(Conf.OptPipeline);
136 AddString(Conf.AAPipeline);
137 AddString(Conf.OverrideTriple);
138 AddString(Conf.DefaultTriple);
139
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000140 // Include the hash for the current module
141 auto ModHash = Index.getModuleHash(ModuleID);
142 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
143 for (auto F : ExportList)
144 // The export list can impact the internalization, be conservative here
145 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&F, sizeof(F)));
146
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000147 // Include the hash for every module we import functions from. The set of
148 // imported symbols for each module may affect code generation and is
149 // sensitive to link order, so include that as well.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000150 for (auto &Entry : ImportList) {
151 auto ModHash = Index.getModuleHash(Entry.first());
152 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000153
154 AddUint64(Entry.second.size());
155 for (auto &Fn : Entry.second)
156 AddUint64(Fn.first);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000157 }
158
159 // Include the hash for the resolved ODR.
160 for (auto &Entry : ResolvedODR) {
161 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.first,
162 sizeof(GlobalValue::GUID)));
163 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.second,
164 sizeof(GlobalValue::LinkageTypes)));
165 }
166
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000167 // Members of CfiFunctionDefs and CfiFunctionDecls that are referenced or
168 // defined in this module.
169 std::set<GlobalValue::GUID> UsedCfiDefs;
170 std::set<GlobalValue::GUID> UsedCfiDecls;
171
172 // Typeids used in this module.
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000173 std::set<GlobalValue::GUID> UsedTypeIds;
174
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000175 auto AddUsedCfiGlobal = [&](GlobalValue::GUID ValueGUID) {
176 if (CfiFunctionDefs.count(ValueGUID))
177 UsedCfiDefs.insert(ValueGUID);
178 if (CfiFunctionDecls.count(ValueGUID))
179 UsedCfiDecls.insert(ValueGUID);
180 };
181
182 auto AddUsedThings = [&](GlobalValueSummary *GS) {
183 if (!GS) return;
Peter Collingbourne7f1a5ba2018-02-09 05:58:55 +0000184 AddUnsigned(GS->isLive());
Peter Collingbourneb4edfb92018-02-05 17:17:51 +0000185 for (const ValueInfo &VI : GS->refs()) {
186 AddUnsigned(VI.isDSOLocal());
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000187 AddUsedCfiGlobal(VI.getGUID());
Peter Collingbourneb4edfb92018-02-05 17:17:51 +0000188 }
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000189 if (auto *FS = dyn_cast<FunctionSummary>(GS)) {
190 for (auto &TT : FS->type_tests())
191 UsedTypeIds.insert(TT);
192 for (auto &TT : FS->type_test_assume_vcalls())
193 UsedTypeIds.insert(TT.GUID);
194 for (auto &TT : FS->type_checked_load_vcalls())
195 UsedTypeIds.insert(TT.GUID);
196 for (auto &TT : FS->type_test_assume_const_vcalls())
197 UsedTypeIds.insert(TT.VFunc.GUID);
198 for (auto &TT : FS->type_checked_load_const_vcalls())
199 UsedTypeIds.insert(TT.VFunc.GUID);
Peter Collingbourne3fe815d2018-02-05 23:46:32 +0000200 for (auto &ET : FS->calls()) {
201 AddUnsigned(ET.first.isDSOLocal());
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000202 AddUsedCfiGlobal(ET.first.getGUID());
Peter Collingbourne3fe815d2018-02-05 23:46:32 +0000203 }
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000204 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000205 };
206
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000207 // Include the hash for the linkage type to reflect internalization and weak
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000208 // resolution, and collect any used type identifier resolutions.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000209 for (auto &GS : DefinedGlobals) {
210 GlobalValue::LinkageTypes Linkage = GS.second->linkage();
211 Hasher.update(
212 ArrayRef<uint8_t>((const uint8_t *)&Linkage, sizeof(Linkage)));
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000213 AddUsedCfiGlobal(GS.first);
214 AddUsedThings(GS.second);
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000215 }
216
217 // Imported functions may introduce new uses of type identifier resolutions,
218 // so we need to collect their used resolutions as well.
219 for (auto &ImpM : ImportList)
220 for (auto &ImpF : ImpM.second)
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000221 AddUsedThings(Index.findSummaryInModule(ImpF.first, ImpM.first()));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000222
223 auto AddTypeIdSummary = [&](StringRef TId, const TypeIdSummary &S) {
224 AddString(TId);
225
226 AddUnsigned(S.TTRes.TheKind);
227 AddUnsigned(S.TTRes.SizeM1BitWidth);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000228
Peter Collingbourneb9b60252017-09-11 22:49:10 +0000229 AddUint64(S.TTRes.AlignLog2);
230 AddUint64(S.TTRes.SizeM1);
231 AddUint64(S.TTRes.BitMask);
232 AddUint64(S.TTRes.InlineBits);
233
Peter Collingbourne711284b2017-03-10 21:37:10 +0000234 AddUint64(S.WPDRes.size());
235 for (auto &WPD : S.WPDRes) {
236 AddUnsigned(WPD.first);
237 AddUnsigned(WPD.second.TheKind);
238 AddString(WPD.second.SingleImplName);
239
240 AddUint64(WPD.second.ResByArg.size());
241 for (auto &ByArg : WPD.second.ResByArg) {
242 AddUint64(ByArg.first.size());
243 for (uint64_t Arg : ByArg.first)
244 AddUint64(Arg);
245 AddUnsigned(ByArg.second.TheKind);
246 AddUint64(ByArg.second.Info);
Peter Collingbourneb15a35e2017-09-11 22:34:42 +0000247 AddUnsigned(ByArg.second.Byte);
248 AddUnsigned(ByArg.second.Bit);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000249 }
250 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000251 };
252
253 // Include the hash for all type identifiers used by this module.
254 for (GlobalValue::GUID TId : UsedTypeIds) {
255 auto SummariesI = TypeIdSummariesByGuid.find(TId);
256 if (SummariesI != TypeIdSummariesByGuid.end())
257 for (auto *Summary : SummariesI->second)
258 AddTypeIdSummary(Summary->first, Summary->second);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000259 }
260
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000261 AddUnsigned(UsedCfiDefs.size());
262 for (auto &V : UsedCfiDefs)
263 AddUint64(V);
264
265 AddUnsigned(UsedCfiDecls.size());
266 for (auto &V : UsedCfiDecls)
267 AddUint64(V);
268
Dehao Chen27978002016-12-16 16:48:46 +0000269 if (!Conf.SampleProfile.empty()) {
270 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile);
271 if (FileOrErr)
272 Hasher.update(FileOrErr.get()->getBuffer());
273 }
274
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000275 Key = toHex(Hasher.result());
276}
277
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000278static void thinLTOResolveWeakForLinkerGUID(
279 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
280 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000281 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000282 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000283 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000284 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000285 for (auto &S : GVSummaryList) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000286 GlobalValue::LinkageTypes OriginalLinkage = S->linkage();
287 if (!GlobalValue::isWeakForLinker(OriginalLinkage))
288 continue;
Peter Collingbourne73589f32016-07-07 18:31:51 +0000289 // We need to emit only one of these. The prevailing module will keep it,
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000290 // but turned into a weak, while the others will drop it when possible.
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000291 // This is both a compile-time optimization and a correctness
292 // transformation. This is necessary for correctness when we have exported
293 // a reference - we need to convert the linkonce to weak to
294 // ensure a copy is kept to satisfy the exported reference.
295 // FIXME: We may want to split the compile time and correctness
296 // aspects into separate routines.
Peter Collingbourne73589f32016-07-07 18:31:51 +0000297 if (isPrevailing(GUID, S.get())) {
Teresa Johnson28c03b52016-05-26 14:16:52 +0000298 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
299 S->setLinkage(GlobalValue::getWeakLinkage(
300 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000301 }
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000302 // Alias and aliasee can't be turned into available_externally.
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000303 else if (!isa<AliasSummary>(S.get()) &&
Teresa Johnson4566c6d2017-01-20 21:54:58 +0000304 !GlobalInvolvedWithAlias.count(S.get()))
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000305 S->setLinkage(GlobalValue::AvailableExternallyLinkage);
306 if (S->linkage() != OriginalLinkage)
307 recordNewLinkage(S->modulePath(), GUID, S->linkage());
308 }
309}
310
311// Resolve Weak and LinkOnce values in the \p Index.
312//
313// We'd like to drop these functions if they are no longer referenced in the
314// current module. However there is a chance that another module is still
315// referencing them because of the import. We make sure we always emit at least
316// one copy.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000317void llvm::thinLTOResolveWeakForLinkerInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000318 ModuleSummaryIndex &Index,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000319 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000320 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000321 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000322 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000323 // We won't optimize the globals that are referenced by an alias for now
324 // Ideally we should turn the alias into a global and duplicate the definition
325 // when needed.
326 DenseSet<GlobalValueSummary *> GlobalInvolvedWithAlias;
327 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000328 for (auto &S : I.second.SummaryList)
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000329 if (auto AS = dyn_cast<AliasSummary>(S.get()))
330 GlobalInvolvedWithAlias.insert(&AS->getAliasee());
331
332 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000333 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first,
334 GlobalInvolvedWithAlias, isPrevailing,
335 recordNewLinkage);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000336}
337
338static void thinLTOInternalizeAndPromoteGUID(
339 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000340 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000341 for (auto &S : GVSummaryList) {
Mehdi Amini1380edf2017-02-03 07:41:43 +0000342 if (isExported(S->modulePath(), GUID)) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000343 if (GlobalValue::isLocalLinkage(S->linkage()))
344 S->setLinkage(GlobalValue::ExternalLinkage);
345 } else if (!GlobalValue::isLocalLinkage(S->linkage()))
346 S->setLinkage(GlobalValue::InternalLinkage);
347 }
348}
349
350// Update the linkages in the given \p Index to mark exported values
351// as external and non-exported values as internal.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000352void llvm::thinLTOInternalizeAndPromoteInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000353 ModuleSummaryIndex &Index,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000354 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000355 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000356 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000357}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000358
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000359// Requires a destructor for std::vector<InputModule>.
360InputFile::~InputFile() = default;
361
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000362Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) {
363 std::unique_ptr<InputFile> File(new InputFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000364
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000365 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object);
366 if (!FOrErr)
367 return FOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000368
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000369 File->TargetTriple = FOrErr->TheReader.getTargetTriple();
370 File->SourceFileName = FOrErr->TheReader.getSourceFileName();
371 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts();
372 File->ComdatTable = FOrErr->TheReader.getComdatTable();
Peter Collingbournead903692016-12-13 19:43:49 +0000373
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000374 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000375 size_t Begin = File->Symbols.size();
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000376 for (const irsymtab::Reader::SymbolRef &Sym :
377 FOrErr->TheReader.module_symbols(I))
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000378 // Skip symbols that are irrelevant to LTO. Note that this condition needs
379 // to match the one in Skip() in LTO::addRegularLTO().
380 if (Sym.isGlobal() && !Sym.isFormatSpecific())
381 File->Symbols.push_back(Sym);
382 File->ModuleSymIndices.push_back({Begin, File->Symbols.size()});
Rafael Espindola79121102016-10-25 12:02:03 +0000383 }
384
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000385 File->Mods = FOrErr->Mods;
386 File->Strtab = std::move(FOrErr->Strtab);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000387 return std::move(File);
388}
389
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000390StringRef InputFile::getName() const {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000391 return Mods[0].getModuleIdentifier();
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000392}
393
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000394LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel,
395 Config &Conf)
396 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel),
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000397 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)),
398 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000399
Eugene Leviant28d8a492018-01-22 13:35:40 +0000400LTO::ThinLTOState::ThinLTOState(ThinBackend Backend)
401 : Backend(Backend), CombinedIndex(/*IsPeformingAnalysis*/ false) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000402 if (!Backend)
Teresa Johnsonec544c52016-10-19 17:35:01 +0000403 this->Backend =
404 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency());
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000405}
406
407LTO::LTO(Config Conf, ThinBackend Backend,
408 unsigned ParallelCodeGenParallelismLevel)
409 : Conf(std::move(Conf)),
410 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf),
Mehdi Amini026ddbb2016-08-19 05:56:37 +0000411 ThinLTO(std::move(Backend)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000412
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000413// Requires a destructor for MapVector<BitcodeModule>.
414LTO::~LTO() = default;
415
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000416// Add the symbols in the given module to the GlobalResolutions map, and resolve
417// their partitions.
418void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms,
419 ArrayRef<SymbolResolution> Res,
420 unsigned Partition, bool InSummary) {
421 auto *ResI = Res.begin();
422 auto *ResE = Res.end();
Peter Collingbourne7e85b262017-06-15 17:41:32 +0000423 (void)ResE;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000424 for (const InputFile::Symbol &Sym : Syms) {
425 assert(ResI != ResE);
426 SymbolResolution Res = *ResI++;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000427
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000428 auto &GlobalRes = GlobalResolutions[Sym.getName()];
429 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr();
Eugene Leviant746f1522017-12-15 09:18:21 +0000430 if (Res.Prevailing) {
George Rimard3283652018-01-25 17:23:27 +0000431 assert(!GlobalRes.Prevailing &&
Eugene Leviantcb122492017-12-15 16:27:33 +0000432 "Multiple prevailing defs are not allowed");
George Rimard3283652018-01-25 17:23:27 +0000433 GlobalRes.Prevailing = true;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000434 GlobalRes.IRName = Sym.getIRName();
George Rimareaf51722018-01-29 08:03:30 +0000435 } else if (!GlobalRes.Prevailing && GlobalRes.IRName.empty()) {
436 // Sometimes it can be two copies of symbol in a module and prevailing
437 // symbol can have no IR name. That might happen if symbol is defined in
438 // module level inline asm block. In case we have multiple modules with
439 // the same symbol we want to use IR name of the prevailing symbol.
440 // Otherwise, if we haven't seen a prevailing symbol, set the name so that
441 // we can later use it to check if there is any prevailing copy in IR.
442 GlobalRes.IRName = Sym.getIRName();
Eugene Leviant746f1522017-12-15 09:18:21 +0000443 }
Teresa Johnson6c475a72017-01-05 21:34:18 +0000444
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000445 // Set the partition to external if we know it is re-defined by the linker
446 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a
447 // regular object, is referenced from llvm.compiler_used, or was already
448 // recorded as being referenced from a different partition.
449 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() ||
450 (GlobalRes.Partition != GlobalResolution::Unknown &&
451 GlobalRes.Partition != Partition)) {
452 GlobalRes.Partition = GlobalResolution::External;
453 } else
454 // First recorded reference, save the current partition.
455 GlobalRes.Partition = Partition;
456
457 // Flag as visible outside of summary if visible from a regular object or
458 // from a module that does not have a summary.
459 GlobalRes.VisibleOutsideSummary |=
460 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary);
461 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000462}
463
Rafael Espindola7775c332016-08-26 20:19:35 +0000464static void writeToResolutionFile(raw_ostream &OS, InputFile *Input,
465 ArrayRef<SymbolResolution> Res) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000466 StringRef Path = Input->getName();
Rafael Espindola7775c332016-08-26 20:19:35 +0000467 OS << Path << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000468 auto ResI = Res.begin();
469 for (const InputFile::Symbol &Sym : Input->symbols()) {
470 assert(ResI != Res.end());
471 SymbolResolution Res = *ResI++;
472
Rafael Espindola7775c332016-08-26 20:19:35 +0000473 OS << "-r=" << Path << ',' << Sym.getName() << ',';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000474 if (Res.Prevailing)
Rafael Espindola7775c332016-08-26 20:19:35 +0000475 OS << 'p';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000476 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola7775c332016-08-26 20:19:35 +0000477 OS << 'l';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000478 if (Res.VisibleToRegularObj)
Rafael Espindola7775c332016-08-26 20:19:35 +0000479 OS << 'x';
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000480 if (Res.LinkerRedefined)
481 OS << 'r';
Rafael Espindola7775c332016-08-26 20:19:35 +0000482 OS << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000483 }
Peter Collingbourne58ffcfb2017-01-19 23:10:14 +0000484 OS.flush();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000485 assert(ResI == Res.end());
486}
487
488Error LTO::add(std::unique_ptr<InputFile> Input,
489 ArrayRef<SymbolResolution> Res) {
490 assert(!CalledGetMaxTasks);
491
492 if (Conf.ResolutionFile)
Rafael Espindola7775c332016-08-26 20:19:35 +0000493 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000494
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000495 if (RegularLTO.CombinedModule->getTargetTriple().empty())
496 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple());
497
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000498 const SymbolResolution *ResI = Res.begin();
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000499 for (unsigned I = 0; I != Input->Mods.size(); ++I)
500 if (Error Err = addModule(*Input, I, ResI, Res.end()))
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000501 return Err;
502
503 assert(ResI == Res.end());
504 return Error::success();
505}
506
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000507Error LTO::addModule(InputFile &Input, unsigned ModI,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000508 const SymbolResolution *&ResI,
509 const SymbolResolution *ResE) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000510 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo();
511 if (!LTOInfo)
512 return LTOInfo.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000513
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000514 BitcodeModule BM = Input.Mods[ModI];
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000515 auto ModSyms = Input.module_symbols(ModI);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000516 addModuleToGlobalRes(ModSyms, {ResI, ResE},
517 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0,
518 LTOInfo->HasSummary);
519
520 if (LTOInfo->IsThinLTO)
521 return addThinLTO(BM, ModSyms, ResI, ResE);
522
523 Expected<RegularLTOState::AddedModule> ModOrErr =
524 addRegularLTO(BM, ModSyms, ResI, ResE);
525 if (!ModOrErr)
526 return ModOrErr.takeError();
527
528 if (!LTOInfo->HasSummary)
529 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false);
530
531 // Regular LTO module summaries are added to a dummy module that represents
532 // the combined regular LTO module.
533 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull))
534 return Err;
535 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr));
536 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000537}
538
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000539// Checks whether the given global value is in a non-prevailing comdat
540// (comdat containing values the linker indicated were not prevailing,
541// which we then dropped to available_externally), and if so, removes
542// it from the comdat. This is called for all global values to ensure the
543// comdat is empty rather than leaving an incomplete comdat. It is needed for
544// regular LTO modules, in case we are in a mixed-LTO mode (both regular
545// and thin LTO modules) compilation. Since the regular LTO module will be
546// linked first in the final native link, we want to make sure the linker
547// doesn't select any of these incomplete comdats that would be left
548// in the regular LTO module without this cleanup.
549static void
550handleNonPrevailingComdat(GlobalValue &GV,
551 std::set<const Comdat *> &NonPrevailingComdats) {
552 Comdat *C = GV.getComdat();
553 if (!C)
554 return;
555
556 if (!NonPrevailingComdats.count(C))
557 return;
558
559 // Additionally need to drop externally visible global values from the comdat
560 // to available_externally, so that there aren't multiply defined linker
561 // errors.
562 if (!GV.hasLocalLinkage())
563 GV.setLinkage(GlobalValue::AvailableExternallyLinkage);
564
565 if (auto GO = dyn_cast<GlobalObject>(&GV))
566 GO->setComdat(nullptr);
567}
568
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000569// Add a regular LTO object to the link.
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000570// The resulting module needs to be linked into the combined LTO module with
571// linkRegularLTO.
572Expected<LTO::RegularLTOState::AddedModule>
573LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
574 const SymbolResolution *&ResI,
575 const SymbolResolution *ResE) {
576 RegularLTOState::AddedModule Mod;
Peter Collingbournead903692016-12-13 19:43:49 +0000577 Expected<std::unique_ptr<Module>> MOrErr =
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000578 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true,
579 /*IsImporting*/ false);
Peter Collingbournead903692016-12-13 19:43:49 +0000580 if (!MOrErr)
581 return MOrErr.takeError();
Peter Collingbournead903692016-12-13 19:43:49 +0000582 Module &M = **MOrErr;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000583 Mod.M = std::move(*MOrErr);
584
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000585 if (Error Err = M.materializeMetadata())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000586 return std::move(Err);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000587 UpgradeDebugInfo(M);
588
Peter Collingbournead903692016-12-13 19:43:49 +0000589 ModuleSymbolTable SymTab;
590 SymTab.addModule(&M);
591
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000592 for (GlobalVariable &GV : M.globals())
593 if (GV.hasAppendingLinkage())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000594 Mod.Keep.push_back(&GV);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000595
Peter Collingbourne46136262017-02-02 05:22:42 +0000596 DenseSet<GlobalObject *> AliasedGlobals;
597 for (auto &GA : M.aliases())
598 if (GlobalObject *GO = GA.getBaseObject())
599 AliasedGlobals.insert(GO);
600
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000601 // In this function we need IR GlobalValues matching the symbols in Syms
602 // (which is not backed by a module), so we need to enumerate them in the same
603 // order. The symbol enumeration order of a ModuleSymbolTable intentionally
604 // matches the order of an irsymtab, but when we read the irsymtab in
605 // InputFile::create we omit some symbols that are irrelevant to LTO. The
606 // Skip() function skips the same symbols from the module as InputFile does
607 // from the symbol table.
608 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end();
609 auto Skip = [&]() {
610 while (MsymI != MsymE) {
611 auto Flags = SymTab.getSymbolFlags(*MsymI);
612 if ((Flags & object::BasicSymbolRef::SF_Global) &&
613 !(Flags & object::BasicSymbolRef::SF_FormatSpecific))
614 return;
615 ++MsymI;
616 }
617 };
618 Skip();
619
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000620 std::set<const Comdat *> NonPrevailingComdats;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000621 for (const InputFile::Symbol &Sym : Syms) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000622 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000623 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000624
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000625 assert(MsymI != MsymE);
626 ModuleSymbolTable::Symbol Msym = *MsymI++;
627 Skip();
628
629 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) {
Peter Collingbournec387e702017-02-02 05:12:15 +0000630 if (Res.Prevailing) {
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000631 if (Sym.isUndefined())
Peter Collingbournec387e702017-02-02 05:12:15 +0000632 continue;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000633 Mod.Keep.push_back(GV);
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000634 // For symbols re-defined with linker -wrap and -defsym options,
635 // set the linkage to weak to inhibit IPO. The linkage will be
636 // restored by the linker.
637 if (Res.LinkerRedefined)
638 GV->setLinkage(GlobalValue::WeakAnyLinkage);
639
Davide Italianod4db1162017-05-26 21:56:14 +0000640 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage();
641 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
642 GV->setLinkage(GlobalValue::getWeakLinkage(
643 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Peter Collingbourne46136262017-02-02 05:22:42 +0000644 } else if (isa<GlobalObject>(GV) &&
645 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() ||
646 GV->hasAvailableExternallyLinkage()) &&
647 !AliasedGlobals.count(cast<GlobalObject>(GV))) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000648 // Any of the above three types of linkage indicates that the
Peter Collingbourne46136262017-02-02 05:22:42 +0000649 // chosen prevailing symbol will have the same semantics as this copy of
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000650 // the symbol, so we may be able to link it with available_externally
651 // linkage. We will decide later whether to do that when we link this
652 // module (in linkRegularLTO), based on whether it is undefined.
653 Mod.Keep.push_back(GV);
654 GV->setLinkage(GlobalValue::AvailableExternallyLinkage);
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000655 if (GV->hasComdat())
656 NonPrevailingComdats.insert(GV->getComdat());
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000657 cast<GlobalObject>(GV)->setComdat(nullptr);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000658 }
Sean Fertile4595a912017-11-04 17:04:39 +0000659
660 // Set the 'local' flag based on the linker resolution for this symbol.
Rafael Espindola8a1ca672018-01-18 05:38:43 +0000661 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola349fe0a2018-01-24 19:11:24 +0000662 GV->setDSOLocal(true);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000663 }
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000664 // Common resolution: collect the maximum size/alignment over all commons.
665 // We also record if we see an instance of a common as prevailing, so that
666 // if none is prevailing we can ignore it later.
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000667 if (Sym.isCommon()) {
Peter Collingbournefb8c2a42016-12-01 02:51:12 +0000668 // FIXME: We should figure out what to do about commons defined by asm.
669 // For now they aren't reported correctly by ModuleSymbolTable.
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000670 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000671 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
672 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000673 CommonRes.Prevailing |= Res.Prevailing;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000674 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000675
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000676 }
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000677 if (!M.getComdatSymbolTable().empty())
678 for (GlobalValue &GV : M.global_values())
679 handleNonPrevailingComdat(GV, NonPrevailingComdats);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000680 assert(MsymI == MsymE);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000681 return std::move(Mod);
682}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000683
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000684Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
685 bool LivenessFromIndex) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000686 std::vector<GlobalValue *> Keep;
687 for (GlobalValue *GV : Mod.Keep) {
688 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
689 continue;
690
691 if (!GV->hasAvailableExternallyLinkage()) {
692 Keep.push_back(GV);
693 continue;
694 }
695
696 // Only link available_externally definitions if we don't already have a
697 // definition.
698 GlobalValue *CombinedGV =
699 RegularLTO.CombinedModule->getNamedValue(GV->getName());
700 if (CombinedGV && !CombinedGV->isDeclaration())
701 continue;
702
703 Keep.push_back(GV);
704 }
705
706 return RegularLTO.Mover->move(std::move(Mod.M), Keep,
Teresa Johnson4b9b3792016-10-12 18:39:29 +0000707 [](GlobalValue &, IRMover::ValueAdder) {},
Teresa Johnson040cc162016-12-12 16:09:30 +0000708 /* IsPerformingImport */ false);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000709}
710
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000711// Add a ThinLTO module to the link.
712Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000713 const SymbolResolution *&ResI,
714 const SymbolResolution *ResE) {
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000715 if (Error Err =
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000716 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
717 ThinLTO.ModuleMap.size()))
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000718 return Err;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000719
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000720 for (const InputFile::Symbol &Sym : Syms) {
721 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000722 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000723
Sean Fertile4595a912017-11-04 17:04:39 +0000724 if (!Sym.getIRName().empty()) {
725 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
726 Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
727 if (Res.Prevailing) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000728 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
Davide Italiano6a5fbe52017-07-06 19:58:26 +0000729
730 // For linker redefined symbols (via --wrap or --defsym) we want to
731 // switch the linkage to `weak` to prevent IPOs from happening.
732 // Find the summary in the module for this very GV and record the new
733 // linkage so that we can switch it when we import the GV.
734 if (Res.LinkerRedefined)
735 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
736 GUID, BM.getModuleIdentifier()))
737 S->setLinkage(GlobalValue::WeakAnyLinkage);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000738 }
Sean Fertile4595a912017-11-04 17:04:39 +0000739
740 // If the linker resolved the symbol to a local definition then mark it
741 // as local in the summary for the module we are adding.
742 if (Res.FinalDefinitionInLinkageUnit) {
743 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
744 GUID, BM.getModuleIdentifier())) {
745 S->setDSOLocal(true);
746 }
747 }
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000748 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000749 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000750
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000751 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second)
752 return make_error<StringError>(
753 "Expected at most one ThinLTO module per bitcode file",
754 inconvertibleErrorCode());
755
Mehdi Amini41af4302016-11-11 04:28:40 +0000756 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000757}
758
Teresa Johnsonfaa75062016-08-11 20:38:39 +0000759unsigned LTO::getMaxTasks() const {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000760 CalledGetMaxTasks = true;
761 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
762}
763
Peter Collingbourne80186a52016-09-23 21:33:43 +0000764Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000765 // Compute "dead" symbols, we don't want to import/export these!
766 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
George Rimareaf51722018-01-29 08:03:30 +0000767 DenseMap<GlobalValue::GUID, PrevailingType> GUIDPrevailingResolutions;
768 for (auto &Res : GlobalResolutions) {
769 // Normally resolution have IR name of symbol. We can do nothing here
770 // otherwise. See comments in GlobalResolution struct for more details.
771 if (Res.second.IRName.empty())
772 continue;
773
774 GlobalValue::GUID GUID = GlobalValue::getGUID(
775 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
776
George Rimard3283652018-01-25 17:23:27 +0000777 if (Res.second.VisibleOutsideSummary && Res.second.Prevailing)
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000778 GUIDPreservedSymbols.insert(GlobalValue::getGUID(
779 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000780
George Rimareaf51722018-01-29 08:03:30 +0000781 GUIDPrevailingResolutions[GUID] =
782 Res.second.Prevailing ? PrevailingType::Yes : PrevailingType::No;
783 }
784
785 auto isPrevailing = [&](GlobalValue::GUID G) {
786 auto It = GUIDPrevailingResolutions.find(G);
787 if (It == GUIDPrevailingResolutions.end())
788 return PrevailingType::Unknown;
789 return It->second;
790 };
791 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols, isPrevailing);
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000792
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000793 if (auto E = runRegularLTO(AddStream))
794 return E;
795 return runThinLTO(AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000796}
797
Peter Collingbourne80186a52016-09-23 21:33:43 +0000798Error LTO::runRegularLTO(AddStreamFn AddStream) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000799 for (auto &M : RegularLTO.ModsWithSummaries)
800 if (Error Err = linkRegularLTO(std::move(M),
801 /*LivenessFromIndex=*/true))
802 return Err;
803
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000804 // Make sure commons have the right size/alignment: we kept the largest from
805 // all the prevailing when adding the inputs, and we apply it here.
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000806 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000807 for (auto &I : RegularLTO.Commons) {
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000808 if (!I.second.Prevailing)
809 // Don't do anything if no instance of this common was prevailing.
810 continue;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000811 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000812 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000813 // Don't create a new global if the type is already correct, just make
814 // sure the alignment is correct.
815 OldGV->setAlignment(I.second.Align);
816 continue;
817 }
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000818 ArrayType *Ty =
819 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000820 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false,
821 GlobalValue::CommonLinkage,
822 ConstantAggregateZero::get(Ty), "");
823 GV->setAlignment(I.second.Align);
824 if (OldGV) {
825 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType()));
826 GV->takeName(OldGV);
827 OldGV->eraseFromParent();
828 } else {
829 GV->setName(I.first);
830 }
831 }
832
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000833 if (Conf.PreOptModuleHook &&
834 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000835 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000836
Mehdi Aminid310b472016-08-22 06:25:41 +0000837 if (!Conf.CodeGenOnly) {
838 for (const auto &R : GlobalResolutions) {
George Rimareaf51722018-01-29 08:03:30 +0000839 if (!R.second.isPrevailingIRSymbol())
Mehdi Aminid310b472016-08-22 06:25:41 +0000840 continue;
841 if (R.second.Partition != 0 &&
842 R.second.Partition != GlobalResolution::External)
843 continue;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000844
Mehdi Aminid310b472016-08-22 06:25:41 +0000845 GlobalValue *GV =
846 RegularLTO.CombinedModule->getNamedValue(R.second.IRName);
847 // Ignore symbols defined in other partitions.
848 if (!GV || GV->hasLocalLinkage())
849 continue;
850 GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global
851 : GlobalValue::UnnamedAddr::None);
852 if (R.second.Partition == 0)
853 GV->setLinkage(GlobalValue::InternalLinkage);
854 }
855
856 if (Conf.PostInternalizeModuleHook &&
857 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000858 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000859 }
Peter Collingbourne80186a52016-09-23 21:33:43 +0000860 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel,
Peter Collingbournee02b74e2017-01-20 22:18:52 +0000861 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000862}
863
864/// This class defines the interface to the ThinLTO backend.
865class lto::ThinBackendProc {
866protected:
867 Config &Conf;
868 ModuleSummaryIndex &CombinedIndex;
Mehdi Amini767e1452016-09-06 03:23:45 +0000869 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000870
871public:
872 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +0000873 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries)
Mehdi Amini18b91112016-08-19 06:10:03 +0000874 : Conf(Conf), CombinedIndex(CombinedIndex),
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000875 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {}
876
877 virtual ~ThinBackendProc() {}
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000878 virtual Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000879 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000880 const FunctionImporter::ImportMapTy &ImportList,
881 const FunctionImporter::ExportSetTy &ExportList,
882 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000883 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000884 virtual Error wait() = 0;
885};
886
Benjamin Kramerffd37152016-11-19 20:44:26 +0000887namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000888class InProcessThinBackend : public ThinBackendProc {
889 ThreadPool BackendThreadPool;
Peter Collingbourne80186a52016-09-23 21:33:43 +0000890 AddStreamFn AddStream;
891 NativeObjectCache Cache;
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000892 TypeIdSummariesByGuidTy TypeIdSummariesByGuid;
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000893 std::set<GlobalValue::GUID> CfiFunctionDefs;
894 std::set<GlobalValue::GUID> CfiFunctionDecls;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000895
896 Optional<Error> Err;
897 std::mutex ErrMu;
898
899public:
Mehdi Amini767e1452016-09-06 03:23:45 +0000900 InProcessThinBackend(
901 Config &Conf, ModuleSummaryIndex &CombinedIndex,
902 unsigned ThinLTOParallelismLevel,
903 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000904 AddStreamFn AddStream, NativeObjectCache Cache)
Mehdi Amini18b91112016-08-19 06:10:03 +0000905 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
906 BackendThreadPool(ThinLTOParallelismLevel),
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000907 AddStream(std::move(AddStream)), Cache(std::move(Cache)) {
908 // Create a mapping from type identifier GUIDs to type identifier summaries.
909 // This allows backends to use the type identifier GUIDs stored in the
910 // function summaries to determine which type identifier summaries affect
911 // each function without needing to compute GUIDs in each backend.
912 for (auto &TId : CombinedIndex.typeIds())
913 TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId);
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000914 for (auto &Name : CombinedIndex.cfiFunctionDefs())
915 CfiFunctionDefs.insert(
916 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
917 for (auto &Name : CombinedIndex.cfiFunctionDecls())
918 CfiFunctionDecls.insert(
919 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000920 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000921
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000922 Error runThinLTOBackendThread(
Peter Collingbourne80186a52016-09-23 21:33:43 +0000923 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000924 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000925 const FunctionImporter::ImportMapTy &ImportList,
926 const FunctionImporter::ExportSetTy &ExportList,
927 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
928 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000929 MapVector<StringRef, BitcodeModule> &ModuleMap,
930 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Peter Collingbourne80186a52016-09-23 21:33:43 +0000931 auto RunThinBackend = [&](AddStreamFn AddStream) {
932 LTOLLVMContext BackendContext(Conf);
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000933 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
Peter Collingbourned9445c42016-11-13 07:00:17 +0000934 if (!MOrErr)
935 return MOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000936
Peter Collingbourne80186a52016-09-23 21:33:43 +0000937 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
938 ImportList, DefinedGlobals, ModuleMap);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000939 };
Peter Collingbourne80186a52016-09-23 21:33:43 +0000940
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000941 auto ModuleID = BM.getModuleIdentifier();
Mehdi Aminif82bda02016-10-08 04:44:23 +0000942
943 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) ||
944 all_of(CombinedIndex.getModuleHash(ModuleID),
945 [](uint32_t V) { return V == 0; }))
946 // Cache disabled or no entry for this module in the combined index or
947 // no module hash.
Peter Collingbourne80186a52016-09-23 21:33:43 +0000948 return RunThinBackend(AddStream);
949
950 SmallString<40> Key;
951 // The module may be cached, this helps handling it.
Peter Collingbournef4257522016-12-08 05:28:30 +0000952 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000953 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid,
954 CfiFunctionDefs, CfiFunctionDecls);
Peter Collingbourne80186a52016-09-23 21:33:43 +0000955 if (AddStreamFn CacheAddStream = Cache(Task, Key))
956 return RunThinBackend(CacheAddStream);
957
Mehdi Amini41af4302016-11-11 04:28:40 +0000958 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000959 }
960
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000961 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000962 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000963 const FunctionImporter::ImportMapTy &ImportList,
964 const FunctionImporter::ExportSetTy &ExportList,
965 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000966 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
967 StringRef ModulePath = BM.getModuleIdentifier();
Mehdi Amini767e1452016-09-06 03:23:45 +0000968 assert(ModuleToDefinedGVSummaries.count(ModulePath));
969 const GVSummaryMapTy &DefinedGlobals =
970 ModuleToDefinedGVSummaries.find(ModulePath)->second;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000971 BackendThreadPool.async(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000972 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000973 const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000974 const FunctionImporter::ExportSetTy &ExportList,
975 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
976 &ResolvedODR,
Mehdi Amini767e1452016-09-06 03:23:45 +0000977 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000978 MapVector<StringRef, BitcodeModule> &ModuleMap,
979 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000980 Error E = runThinLTOBackendThread(
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000981 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
982 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000983 if (E) {
984 std::unique_lock<std::mutex> L(ErrMu);
985 if (Err)
986 Err = joinErrors(std::move(*Err), std::move(E));
987 else
988 Err = std::move(E);
989 }
990 },
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000991 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
992 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap),
993 std::ref(TypeIdSummariesByGuid));
Mehdi Amini41af4302016-11-11 04:28:40 +0000994 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000995 }
996
997 Error wait() override {
998 BackendThreadPool.wait();
999 if (Err)
1000 return std::move(*Err);
1001 else
Mehdi Amini41af4302016-11-11 04:28:40 +00001002 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001003 }
1004};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001005} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001006
1007ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
1008 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001009 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001010 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001011 return llvm::make_unique<InProcessThinBackend>(
1012 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001013 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001014 };
1015}
1016
Teresa Johnson3f212b82016-09-21 19:12:05 +00001017// Given the original \p Path to an output file, replace any path
1018// prefix matching \p OldPrefix with \p NewPrefix. Also, create the
1019// resulting directory if it does not yet exist.
1020std::string lto::getThinLTOOutputFile(const std::string &Path,
1021 const std::string &OldPrefix,
1022 const std::string &NewPrefix) {
1023 if (OldPrefix.empty() && NewPrefix.empty())
1024 return Path;
1025 SmallString<128> NewPath(Path);
1026 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix);
1027 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str());
1028 if (!ParentPath.empty()) {
1029 // Make sure the new directory exists, creating it if necessary.
1030 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath))
1031 llvm::errs() << "warning: could not create directory '" << ParentPath
1032 << "': " << EC.message() << '\n';
1033 }
1034 return NewPath.str();
1035}
1036
Benjamin Kramerffd37152016-11-19 20:44:26 +00001037namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001038class WriteIndexesThinBackend : public ThinBackendProc {
1039 std::string OldPrefix, NewPrefix;
1040 bool ShouldEmitImportsFiles;
1041
1042 std::string LinkedObjectsFileName;
1043 std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile;
1044
Vitaly Buka59baf732018-01-30 21:19:26 +00001045 lto::IndexWriteCallback OnWrite;
1046
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001047public:
Mehdi Amini767e1452016-09-06 03:23:45 +00001048 WriteIndexesThinBackend(
1049 Config &Conf, ModuleSummaryIndex &CombinedIndex,
1050 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1051 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
Vitaly Buka59baf732018-01-30 21:19:26 +00001052 std::string LinkedObjectsFileName, lto::IndexWriteCallback OnWrite)
Mehdi Amini18b91112016-08-19 06:10:03 +00001053 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001054 OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1055 ShouldEmitImportsFiles(ShouldEmitImportsFiles),
Vitaly Buka59baf732018-01-30 21:19:26 +00001056 LinkedObjectsFileName(LinkedObjectsFileName), OnWrite(OnWrite) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001057
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001058 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001059 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001060 const FunctionImporter::ImportMapTy &ImportList,
1061 const FunctionImporter::ExportSetTy &ExportList,
1062 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001063 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1064 StringRef ModulePath = BM.getModuleIdentifier();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001065 std::string NewModulePath =
1066 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1067
1068 std::error_code EC;
1069 if (!LinkedObjectsFileName.empty()) {
1070 if (!LinkedObjectsFile) {
1071 LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>(
1072 LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None);
1073 if (EC)
1074 return errorCodeToError(EC);
1075 }
1076 *LinkedObjectsFile << NewModulePath << '\n';
1077 }
1078
1079 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1080 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001081 ImportList, ModuleToSummariesForIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001082
1083 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) {
1090 EC = EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList);
1091 if (EC)
1092 return errorCodeToError(EC);
1093 }
1094
1095 if (OnWrite)
1096 OnWrite(ModulePath);
Mehdi Amini41af4302016-11-11 04:28:40 +00001097 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001098 }
1099
Mehdi Amini41af4302016-11-11 04:28:40 +00001100 Error wait() override { return Error::success(); }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001101};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001102} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001103
1104ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix,
1105 std::string NewPrefix,
1106 bool ShouldEmitImportsFiles,
Vitaly Buka59baf732018-01-30 21:19:26 +00001107 std::string LinkedObjectsFile,
1108 IndexWriteCallback OnWrite) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001109 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001110 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001111 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001112 return llvm::make_unique<WriteIndexesThinBackend>(
Mehdi Amini18b91112016-08-19 06:10:03 +00001113 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
Vitaly Buka59baf732018-01-30 21:19:26 +00001114 ShouldEmitImportsFiles, LinkedObjectsFile, OnWrite);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001115 };
1116}
1117
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001118Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001119 if (ThinLTO.ModuleMap.empty())
Mehdi Amini41af4302016-11-11 04:28:40 +00001120 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001121
1122 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
Mehdi Amini41af4302016-11-11 04:28:40 +00001123 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001124
1125 // Collect for each module the list of function it defines (GUID ->
1126 // Summary).
Dehao Chen5d96ee42017-07-10 20:12:54 +00001127 StringMap<GVSummaryMapTy>
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001128 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1129 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1130 ModuleToDefinedGVSummaries);
Teresa Johnson620c1402016-09-20 23:07:17 +00001131 // Create entries for any modules that didn't have any GV summaries
1132 // (either they didn't have any GVs to start with, or we suppressed
1133 // generation of the summaries because they e.g. had inline assembly
1134 // uses that couldn't be promoted/renamed on export). This is so
1135 // InProcessThinBackend::start can still launch a backend thread, which
1136 // is passed the map of summaries for the module, without any special
1137 // handling for this case.
1138 for (auto &Mod : ThinLTO.ModuleMap)
1139 if (!ModuleToDefinedGVSummaries.count(Mod.first))
1140 ModuleToDefinedGVSummaries.try_emplace(Mod.first);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001141
1142 StringMap<FunctionImporter::ImportMapTy> ImportLists(
1143 ThinLTO.ModuleMap.size());
1144 StringMap<FunctionImporter::ExportSetTy> ExportLists(
1145 ThinLTO.ModuleMap.size());
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001146 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001147
Charles Saternosb040fcc2018-02-19 15:14:50 +00001148 if (DumpThinCGSCCs)
1149 ThinLTO.CombinedIndex.dumpSCCs(outs());
1150
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001151 if (Conf.OptLevel > 0)
Teresa Johnson002af9b2016-10-31 22:12:21 +00001152 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +00001153 ImportLists, ExportLists);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001154
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001155 // Figure out which symbols need to be internalized. This also needs to happen
1156 // at -O0 because summary-based DCE is implemented using internalization, and
1157 // we must apply DCE consistently with the full LTO module in order to avoid
1158 // undefined references during the final link.
1159 std::set<GlobalValue::GUID> ExportedGUIDs;
1160 for (auto &Res : GlobalResolutions) {
George Rimard3283652018-01-25 17:23:27 +00001161 // If the symbol does not have external references or it is not prevailing,
1162 // then not need to mark it as exported from a ThinLTO partition.
1163 if (Res.second.Partition != GlobalResolution::External ||
George Rimareaf51722018-01-29 08:03:30 +00001164 !Res.second.isPrevailingIRSymbol())
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001165 continue;
1166 auto GUID = GlobalValue::getGUID(
1167 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
1168 // Mark exported unless index-based analysis determined it to be dead.
1169 if (ThinLTO.CombinedIndex.isGUIDLive(GUID))
1170 ExportedGUIDs.insert(GUID);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001171 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001172
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001173 // Any functions referenced by the jump table in the regular LTO object must
1174 // be exported.
1175 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs())
1176 ExportedGUIDs.insert(
1177 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def)));
1178
1179 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) {
1180 const auto &ExportList = ExportLists.find(ModuleIdentifier);
1181 return (ExportList != ExportLists.end() &&
1182 ExportList->second.count(GUID)) ||
1183 ExportedGUIDs.count(GUID);
1184 };
1185 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported);
1186
Peter Collingbournef87197a2017-05-25 23:40:11 +00001187 auto isPrevailing = [&](GlobalValue::GUID GUID,
1188 const GlobalValueSummary *S) {
1189 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath();
1190 };
1191 auto recordNewLinkage = [&](StringRef ModuleIdentifier,
1192 GlobalValue::GUID GUID,
1193 GlobalValue::LinkageTypes NewLinkage) {
1194 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage;
1195 };
1196 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing,
1197 recordNewLinkage);
1198
Peter Collingbourne80186a52016-09-23 21:33:43 +00001199 std::unique_ptr<ThinBackendProc> BackendProc =
1200 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1201 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001202
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001203 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined
1204 // module and parallel code generation partitions.
1205 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001206 for (auto &Mod : ThinLTO.ModuleMap) {
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001207 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001208 ExportLists[Mod.first],
1209 ResolvedODR[Mod.first], ThinLTO.ModuleMap))
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001210 return E;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001211 ++Task;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001212 }
1213
1214 return BackendProc->wait();
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001215}
Davide Italiano690ed9d2017-02-10 23:49:38 +00001216
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001217Expected<std::unique_ptr<ToolOutputFile>>
Davide Italiano690ed9d2017-02-10 23:49:38 +00001218lto::setupOptimizationRemarks(LLVMContext &Context,
1219 StringRef LTORemarksFilename,
1220 bool LTOPassRemarksWithHotness, int Count) {
1221 if (LTORemarksFilename.empty())
1222 return nullptr;
1223
1224 std::string Filename = LTORemarksFilename;
1225 if (Count != -1)
1226 Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1227
1228 std::error_code EC;
1229 auto DiagnosticFile =
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001230 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001231 if (EC)
1232 return errorCodeToError(EC);
1233 Context.setDiagnosticsOutputFile(
1234 llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
1235 if (LTOPassRemarksWithHotness)
Brian Gesiak44e5f6c2017-06-30 18:13:59 +00001236 Context.setDiagnosticsHotnessRequested(true);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001237 DiagnosticFile->keep();
1238 return std::move(DiagnosticFile);
1239}