blob: a5bdeac4d9d44503ef28537d6bc79ddc807c4dd7 [file] [log] [blame]
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001//===-LTO.cpp - LLVM Link Time Optimizer ----------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements functions and classes used to support LTO.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/LTO/LTO.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000015#include "llvm/Analysis/TargetLibraryInfo.h"
16#include "llvm/Analysis/TargetTransformInfo.h"
Teresa Johnsonad176792016-11-11 05:34:58 +000017#include "llvm/Bitcode/BitcodeReader.h"
18#include "llvm/Bitcode/BitcodeWriter.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000019#include "llvm/CodeGen/Analysis.h"
20#include "llvm/IR/AutoUpgrade.h"
21#include "llvm/IR/DiagnosticPrinter.h"
22#include "llvm/IR/LegacyPassManager.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000023#include "llvm/IR/Mangler.h"
24#include "llvm/IR/Metadata.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000025#include "llvm/LTO/LTOBackend.h"
26#include "llvm/Linker/IRMover.h"
Peter Collingbourne192d8522017-03-28 23:35:34 +000027#include "llvm/Object/IRObjectFile.h"
Bob Haarmandd4ebc12017-02-02 23:00:49 +000028#include "llvm/Support/Error.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000029#include "llvm/Support/ManagedStatic.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000030#include "llvm/Support/MemoryBuffer.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000031#include "llvm/Support/Path.h"
Mehdi Aminiadc0e262016-08-23 21:30:12 +000032#include "llvm/Support/SHA1.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000033#include "llvm/Support/SourceMgr.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000034#include "llvm/Support/TargetRegistry.h"
35#include "llvm/Support/ThreadPool.h"
Teresa Johnsonec544c52016-10-19 17:35:01 +000036#include "llvm/Support/Threading.h"
Peter Collingbourne942fa562017-04-13 01:26:12 +000037#include "llvm/Support/VCSRevision.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000038#include "llvm/Support/raw_ostream.h"
Teresa Johnson9ba95f92016-08-11 14:58:12 +000039#include "llvm/Target/TargetMachine.h"
40#include "llvm/Target/TargetOptions.h"
41#include "llvm/Transforms/IPO.h"
42#include "llvm/Transforms/IPO/PassManagerBuilder.h"
43#include "llvm/Transforms/Utils/SplitModule.h"
Teresa Johnsondf6edc52016-05-23 22:54:06 +000044
Teresa Johnson9ba95f92016-08-11 14:58:12 +000045#include <set>
46
47using namespace llvm;
48using namespace lto;
49using namespace object;
Teresa Johnsondf6edc52016-05-23 22:54:06 +000050
Mehdi Aminiadc0e262016-08-23 21:30:12 +000051#define DEBUG_TYPE "lto"
52
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000053// The values are (type identifier, summary) pairs.
54typedef DenseMap<
55 GlobalValue::GUID,
56 TinyPtrVector<const std::pair<const std::string, TypeIdSummary> *>>
57 TypeIdSummariesByGuidTy;
58
Mehdi Aminiadc0e262016-08-23 21:30:12 +000059// Returns a unique hash for the Module considering the current list of
60// export/import and other global analysis results.
61// The hash is produced in \p Key.
62static void computeCacheKey(
Peter Collingbournef4257522016-12-08 05:28:30 +000063 SmallString<40> &Key, const Config &Conf, const ModuleSummaryIndex &Index,
64 StringRef ModuleID, const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +000065 const FunctionImporter::ExportSetTy &ExportList,
66 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +000067 const GVSummaryMapTy &DefinedGlobals,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +000068 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid,
69 const std::set<GlobalValue::GUID> &CfiFunctionDefs,
70 const std::set<GlobalValue::GUID> &CfiFunctionDecls) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +000071 // Compute the unique hash for this entry.
72 // This is based on the current compiler version, the module itself, the
73 // export list, the hash for every single module in the import list, the
74 // list of ResolvedODR for the module, and the list of preserved symbols.
75 SHA1 Hasher;
76
77 // Start with the compiler revision
78 Hasher.update(LLVM_VERSION_STRING);
Peter Collingbourne942fa562017-04-13 01:26:12 +000079#ifdef LLVM_REVISION
Mehdi Aminiadc0e262016-08-23 21:30:12 +000080 Hasher.update(LLVM_REVISION);
81#endif
82
Peter Collingbournef4257522016-12-08 05:28:30 +000083 // Include the parts of the LTO configuration that affect code generation.
84 auto AddString = [&](StringRef Str) {
85 Hasher.update(Str);
86 Hasher.update(ArrayRef<uint8_t>{0});
87 };
88 auto AddUnsigned = [&](unsigned I) {
89 uint8_t Data[4];
90 Data[0] = I;
91 Data[1] = I >> 8;
92 Data[2] = I >> 16;
93 Data[3] = I >> 24;
94 Hasher.update(ArrayRef<uint8_t>{Data, 4});
95 };
Peter Collingbourne54a52b72017-03-03 20:25:30 +000096 auto AddUint64 = [&](uint64_t I) {
97 uint8_t Data[8];
98 Data[0] = I;
99 Data[1] = I >> 8;
100 Data[2] = I >> 16;
101 Data[3] = I >> 24;
102 Data[4] = I >> 32;
103 Data[5] = I >> 40;
104 Data[6] = I >> 48;
105 Data[7] = I >> 56;
106 Hasher.update(ArrayRef<uint8_t>{Data, 8});
107 };
Peter Collingbournef4257522016-12-08 05:28:30 +0000108 AddString(Conf.CPU);
109 // FIXME: Hash more of Options. For now all clients initialize Options from
110 // command-line flags (which is unsupported in production), but may set
111 // RelaxELFRelocations. The clang driver can also pass FunctionSections,
112 // DataSections and DebuggerTuning via command line flags.
113 AddUnsigned(Conf.Options.RelaxELFRelocations);
114 AddUnsigned(Conf.Options.FunctionSections);
115 AddUnsigned(Conf.Options.DataSections);
116 AddUnsigned((unsigned)Conf.Options.DebuggerTuning);
117 for (auto &A : Conf.MAttrs)
118 AddString(A);
Evgeniy Stepanovb9f1b012017-05-22 21:11:35 +0000119 if (Conf.RelocModel)
120 AddUnsigned(*Conf.RelocModel);
121 else
122 AddUnsigned(-1);
Rafael Espindola79e238a2017-08-03 02:16:21 +0000123 if (Conf.CodeModel)
124 AddUnsigned(*Conf.CodeModel);
125 else
126 AddUnsigned(-1);
Peter Collingbournef4257522016-12-08 05:28:30 +0000127 AddUnsigned(Conf.CGOptLevel);
Tobias Edler von Kochf454b9e2017-02-15 20:36:36 +0000128 AddUnsigned(Conf.CGFileType);
Peter Collingbournef4257522016-12-08 05:28:30 +0000129 AddUnsigned(Conf.OptLevel);
Tim Shen4e912aa2017-06-01 23:13:44 +0000130 AddUnsigned(Conf.UseNewPM);
Peter Collingbournef4257522016-12-08 05:28:30 +0000131 AddString(Conf.OptPipeline);
132 AddString(Conf.AAPipeline);
133 AddString(Conf.OverrideTriple);
134 AddString(Conf.DefaultTriple);
135
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000136 // Include the hash for the current module
137 auto ModHash = Index.getModuleHash(ModuleID);
138 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
139 for (auto F : ExportList)
140 // The export list can impact the internalization, be conservative here
141 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&F, sizeof(F)));
142
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000143 // Include the hash for every module we import functions from. The set of
144 // imported symbols for each module may affect code generation and is
145 // sensitive to link order, so include that as well.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000146 for (auto &Entry : ImportList) {
147 auto ModHash = Index.getModuleHash(Entry.first());
148 Hasher.update(ArrayRef<uint8_t>((uint8_t *)&ModHash[0], sizeof(ModHash)));
Peter Collingbourne54a52b72017-03-03 20:25:30 +0000149
150 AddUint64(Entry.second.size());
151 for (auto &Fn : Entry.second)
152 AddUint64(Fn.first);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000153 }
154
155 // Include the hash for the resolved ODR.
156 for (auto &Entry : ResolvedODR) {
157 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.first,
158 sizeof(GlobalValue::GUID)));
159 Hasher.update(ArrayRef<uint8_t>((const uint8_t *)&Entry.second,
160 sizeof(GlobalValue::LinkageTypes)));
161 }
162
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000163 // Members of CfiFunctionDefs and CfiFunctionDecls that are referenced or
164 // defined in this module.
165 std::set<GlobalValue::GUID> UsedCfiDefs;
166 std::set<GlobalValue::GUID> UsedCfiDecls;
167
168 // Typeids used in this module.
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000169 std::set<GlobalValue::GUID> UsedTypeIds;
170
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000171 auto AddUsedCfiGlobal = [&](GlobalValue::GUID ValueGUID) {
172 if (CfiFunctionDefs.count(ValueGUID))
173 UsedCfiDefs.insert(ValueGUID);
174 if (CfiFunctionDecls.count(ValueGUID))
175 UsedCfiDecls.insert(ValueGUID);
176 };
177
178 auto AddUsedThings = [&](GlobalValueSummary *GS) {
179 if (!GS) return;
180 for (const ValueInfo &VI : GS->refs())
181 AddUsedCfiGlobal(VI.getGUID());
182 if (auto *FS = dyn_cast<FunctionSummary>(GS)) {
183 for (auto &TT : FS->type_tests())
184 UsedTypeIds.insert(TT);
185 for (auto &TT : FS->type_test_assume_vcalls())
186 UsedTypeIds.insert(TT.GUID);
187 for (auto &TT : FS->type_checked_load_vcalls())
188 UsedTypeIds.insert(TT.GUID);
189 for (auto &TT : FS->type_test_assume_const_vcalls())
190 UsedTypeIds.insert(TT.VFunc.GUID);
191 for (auto &TT : FS->type_checked_load_const_vcalls())
192 UsedTypeIds.insert(TT.VFunc.GUID);
193 for (auto &ET : FS->calls())
194 AddUsedCfiGlobal(ET.first.getGUID());
195 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000196 };
197
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000198 // Include the hash for the linkage type to reflect internalization and weak
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000199 // resolution, and collect any used type identifier resolutions.
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000200 for (auto &GS : DefinedGlobals) {
201 GlobalValue::LinkageTypes Linkage = GS.second->linkage();
202 Hasher.update(
203 ArrayRef<uint8_t>((const uint8_t *)&Linkage, sizeof(Linkage)));
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000204 AddUsedCfiGlobal(GS.first);
205 AddUsedThings(GS.second);
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000206 }
207
208 // Imported functions may introduce new uses of type identifier resolutions,
209 // so we need to collect their used resolutions as well.
210 for (auto &ImpM : ImportList)
211 for (auto &ImpF : ImpM.second)
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000212 AddUsedThings(Index.findSummaryInModule(ImpF.first, ImpM.first()));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000213
214 auto AddTypeIdSummary = [&](StringRef TId, const TypeIdSummary &S) {
215 AddString(TId);
216
217 AddUnsigned(S.TTRes.TheKind);
218 AddUnsigned(S.TTRes.SizeM1BitWidth);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000219
Peter Collingbourneb9b60252017-09-11 22:49:10 +0000220 AddUint64(S.TTRes.AlignLog2);
221 AddUint64(S.TTRes.SizeM1);
222 AddUint64(S.TTRes.BitMask);
223 AddUint64(S.TTRes.InlineBits);
224
Peter Collingbourne711284b2017-03-10 21:37:10 +0000225 AddUint64(S.WPDRes.size());
226 for (auto &WPD : S.WPDRes) {
227 AddUnsigned(WPD.first);
228 AddUnsigned(WPD.second.TheKind);
229 AddString(WPD.second.SingleImplName);
230
231 AddUint64(WPD.second.ResByArg.size());
232 for (auto &ByArg : WPD.second.ResByArg) {
233 AddUint64(ByArg.first.size());
234 for (uint64_t Arg : ByArg.first)
235 AddUint64(Arg);
236 AddUnsigned(ByArg.second.TheKind);
237 AddUint64(ByArg.second.Info);
Peter Collingbourneb15a35e2017-09-11 22:34:42 +0000238 AddUnsigned(ByArg.second.Byte);
239 AddUnsigned(ByArg.second.Bit);
Peter Collingbourne711284b2017-03-10 21:37:10 +0000240 }
241 }
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000242 };
243
244 // Include the hash for all type identifiers used by this module.
245 for (GlobalValue::GUID TId : UsedTypeIds) {
246 auto SummariesI = TypeIdSummariesByGuid.find(TId);
247 if (SummariesI != TypeIdSummariesByGuid.end())
248 for (auto *Summary : SummariesI->second)
249 AddTypeIdSummary(Summary->first, Summary->second);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000250 }
251
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000252 AddUnsigned(UsedCfiDefs.size());
253 for (auto &V : UsedCfiDefs)
254 AddUint64(V);
255
256 AddUnsigned(UsedCfiDecls.size());
257 for (auto &V : UsedCfiDecls)
258 AddUint64(V);
259
Dehao Chen27978002016-12-16 16:48:46 +0000260 if (!Conf.SampleProfile.empty()) {
261 auto FileOrErr = MemoryBuffer::getFile(Conf.SampleProfile);
262 if (FileOrErr)
263 Hasher.update(FileOrErr.get()->getBuffer());
264 }
265
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000266 Key = toHex(Hasher.result());
267}
268
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000269static void thinLTOResolveWeakForLinkerGUID(
270 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
271 DenseSet<GlobalValueSummary *> &GlobalInvolvedWithAlias,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000272 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000273 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000274 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000275 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000276 for (auto &S : GVSummaryList) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000277 GlobalValue::LinkageTypes OriginalLinkage = S->linkage();
278 if (!GlobalValue::isWeakForLinker(OriginalLinkage))
279 continue;
Peter Collingbourne73589f32016-07-07 18:31:51 +0000280 // We need to emit only one of these. The prevailing module will keep it,
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000281 // but turned into a weak, while the others will drop it when possible.
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000282 // This is both a compile-time optimization and a correctness
283 // transformation. This is necessary for correctness when we have exported
284 // a reference - we need to convert the linkonce to weak to
285 // ensure a copy is kept to satisfy the exported reference.
286 // FIXME: We may want to split the compile time and correctness
287 // aspects into separate routines.
Peter Collingbourne73589f32016-07-07 18:31:51 +0000288 if (isPrevailing(GUID, S.get())) {
Teresa Johnson28c03b52016-05-26 14:16:52 +0000289 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
290 S->setLinkage(GlobalValue::getWeakLinkage(
291 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000292 }
Teresa Johnson3bc8abd2016-10-30 05:15:23 +0000293 // Alias and aliasee can't be turned into available_externally.
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000294 else if (!isa<AliasSummary>(S.get()) &&
Teresa Johnson4566c6d2017-01-20 21:54:58 +0000295 !GlobalInvolvedWithAlias.count(S.get()))
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000296 S->setLinkage(GlobalValue::AvailableExternallyLinkage);
297 if (S->linkage() != OriginalLinkage)
298 recordNewLinkage(S->modulePath(), GUID, S->linkage());
299 }
300}
301
302// Resolve Weak and LinkOnce values in the \p Index.
303//
304// We'd like to drop these functions if they are no longer referenced in the
305// current module. However there is a chance that another module is still
306// referencing them because of the import. We make sure we always emit at least
307// one copy.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000308void llvm::thinLTOResolveWeakForLinkerInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000309 ModuleSummaryIndex &Index,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000310 function_ref<bool(GlobalValue::GUID, const GlobalValueSummary *)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000311 isPrevailing,
Benjamin Kramerd3f4c052016-06-12 16:13:55 +0000312 function_ref<void(StringRef, GlobalValue::GUID, GlobalValue::LinkageTypes)>
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000313 recordNewLinkage) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000314 // We won't optimize the globals that are referenced by an alias for now
315 // Ideally we should turn the alias into a global and duplicate the definition
316 // when needed.
317 DenseSet<GlobalValueSummary *> GlobalInvolvedWithAlias;
318 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000319 for (auto &S : I.second.SummaryList)
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000320 if (auto AS = dyn_cast<AliasSummary>(S.get()))
321 GlobalInvolvedWithAlias.insert(&AS->getAliasee());
322
323 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000324 thinLTOResolveWeakForLinkerGUID(I.second.SummaryList, I.first,
325 GlobalInvolvedWithAlias, isPrevailing,
326 recordNewLinkage);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000327}
328
329static void thinLTOInternalizeAndPromoteGUID(
330 GlobalValueSummaryList &GVSummaryList, GlobalValue::GUID GUID,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000331 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000332 for (auto &S : GVSummaryList) {
Mehdi Amini1380edf2017-02-03 07:41:43 +0000333 if (isExported(S->modulePath(), GUID)) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000334 if (GlobalValue::isLocalLinkage(S->linkage()))
335 S->setLinkage(GlobalValue::ExternalLinkage);
336 } else if (!GlobalValue::isLocalLinkage(S->linkage()))
337 S->setLinkage(GlobalValue::InternalLinkage);
338 }
339}
340
341// Update the linkages in the given \p Index to mark exported values
342// as external and non-exported values as internal.
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000343void llvm::thinLTOInternalizeAndPromoteInIndex(
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000344 ModuleSummaryIndex &Index,
Mehdi Amini1380edf2017-02-03 07:41:43 +0000345 function_ref<bool(StringRef, GlobalValue::GUID)> isExported) {
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000346 for (auto &I : Index)
Peter Collingbourne9667b912017-05-04 18:03:25 +0000347 thinLTOInternalizeAndPromoteGUID(I.second.SummaryList, I.first, isExported);
Teresa Johnson04c9a2d2016-05-25 14:03:11 +0000348}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000349
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000350// Requires a destructor for std::vector<InputModule>.
351InputFile::~InputFile() = default;
352
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000353Expected<std::unique_ptr<InputFile>> InputFile::create(MemoryBufferRef Object) {
354 std::unique_ptr<InputFile> File(new InputFile);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000355
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000356 Expected<IRSymtabFile> FOrErr = readIRSymtab(Object);
357 if (!FOrErr)
358 return FOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000359
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000360 File->TargetTriple = FOrErr->TheReader.getTargetTriple();
361 File->SourceFileName = FOrErr->TheReader.getSourceFileName();
362 File->COFFLinkerOpts = FOrErr->TheReader.getCOFFLinkerOpts();
363 File->ComdatTable = FOrErr->TheReader.getComdatTable();
Peter Collingbournead903692016-12-13 19:43:49 +0000364
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000365 for (unsigned I = 0; I != FOrErr->Mods.size(); ++I) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000366 size_t Begin = File->Symbols.size();
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000367 for (const irsymtab::Reader::SymbolRef &Sym :
368 FOrErr->TheReader.module_symbols(I))
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000369 // Skip symbols that are irrelevant to LTO. Note that this condition needs
370 // to match the one in Skip() in LTO::addRegularLTO().
371 if (Sym.isGlobal() && !Sym.isFormatSpecific())
372 File->Symbols.push_back(Sym);
373 File->ModuleSymIndices.push_back({Begin, File->Symbols.size()});
Rafael Espindola79121102016-10-25 12:02:03 +0000374 }
375
Peter Collingbournec00c2b22017-06-08 01:26:14 +0000376 File->Mods = FOrErr->Mods;
377 File->Strtab = std::move(FOrErr->Strtab);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000378 return std::move(File);
379}
380
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000381StringRef InputFile::getName() const {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000382 return Mods[0].getModuleIdentifier();
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000383}
384
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000385LTO::RegularLTOState::RegularLTOState(unsigned ParallelCodeGenParallelismLevel,
386 Config &Conf)
387 : ParallelCodeGenParallelismLevel(ParallelCodeGenParallelismLevel),
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000388 Ctx(Conf), CombinedModule(llvm::make_unique<Module>("ld-temp.o", Ctx)),
389 Mover(llvm::make_unique<IRMover>(*CombinedModule)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000390
Eugene Leviant28d8a492018-01-22 13:35:40 +0000391LTO::ThinLTOState::ThinLTOState(ThinBackend Backend)
392 : Backend(Backend), CombinedIndex(/*IsPeformingAnalysis*/ false) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000393 if (!Backend)
Teresa Johnsonec544c52016-10-19 17:35:01 +0000394 this->Backend =
395 createInProcessThinBackend(llvm::heavyweight_hardware_concurrency());
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000396}
397
398LTO::LTO(Config Conf, ThinBackend Backend,
399 unsigned ParallelCodeGenParallelismLevel)
400 : Conf(std::move(Conf)),
401 RegularLTO(ParallelCodeGenParallelismLevel, this->Conf),
Mehdi Amini026ddbb2016-08-19 05:56:37 +0000402 ThinLTO(std::move(Backend)) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000403
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000404// Requires a destructor for MapVector<BitcodeModule>.
405LTO::~LTO() = default;
406
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000407// Add the symbols in the given module to the GlobalResolutions map, and resolve
408// their partitions.
409void LTO::addModuleToGlobalRes(ArrayRef<InputFile::Symbol> Syms,
410 ArrayRef<SymbolResolution> Res,
411 unsigned Partition, bool InSummary) {
412 auto *ResI = Res.begin();
413 auto *ResE = Res.end();
Peter Collingbourne7e85b262017-06-15 17:41:32 +0000414 (void)ResE;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000415 for (const InputFile::Symbol &Sym : Syms) {
416 assert(ResI != ResE);
417 SymbolResolution Res = *ResI++;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000418
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000419 auto &GlobalRes = GlobalResolutions[Sym.getName()];
420 GlobalRes.UnnamedAddr &= Sym.isUnnamedAddr();
Eugene Leviant746f1522017-12-15 09:18:21 +0000421 if (Res.Prevailing) {
George Rimard3283652018-01-25 17:23:27 +0000422 assert(!GlobalRes.Prevailing &&
Eugene Leviantcb122492017-12-15 16:27:33 +0000423 "Multiple prevailing defs are not allowed");
George Rimard3283652018-01-25 17:23:27 +0000424 GlobalRes.Prevailing = true;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000425 GlobalRes.IRName = Sym.getIRName();
George Rimareaf51722018-01-29 08:03:30 +0000426 } else if (!GlobalRes.Prevailing && GlobalRes.IRName.empty()) {
427 // Sometimes it can be two copies of symbol in a module and prevailing
428 // symbol can have no IR name. That might happen if symbol is defined in
429 // module level inline asm block. In case we have multiple modules with
430 // the same symbol we want to use IR name of the prevailing symbol.
431 // Otherwise, if we haven't seen a prevailing symbol, set the name so that
432 // we can later use it to check if there is any prevailing copy in IR.
433 GlobalRes.IRName = Sym.getIRName();
Eugene Leviant746f1522017-12-15 09:18:21 +0000434 }
Teresa Johnson6c475a72017-01-05 21:34:18 +0000435
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000436 // Set the partition to external if we know it is re-defined by the linker
437 // with -defsym or -wrap options, used elsewhere, e.g. it is visible to a
438 // regular object, is referenced from llvm.compiler_used, or was already
439 // recorded as being referenced from a different partition.
440 if (Res.LinkerRedefined || Res.VisibleToRegularObj || Sym.isUsed() ||
441 (GlobalRes.Partition != GlobalResolution::Unknown &&
442 GlobalRes.Partition != Partition)) {
443 GlobalRes.Partition = GlobalResolution::External;
444 } else
445 // First recorded reference, save the current partition.
446 GlobalRes.Partition = Partition;
447
448 // Flag as visible outside of summary if visible from a regular object or
449 // from a module that does not have a summary.
450 GlobalRes.VisibleOutsideSummary |=
451 (Res.VisibleToRegularObj || Sym.isUsed() || !InSummary);
452 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000453}
454
Rafael Espindola7775c332016-08-26 20:19:35 +0000455static void writeToResolutionFile(raw_ostream &OS, InputFile *Input,
456 ArrayRef<SymbolResolution> Res) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000457 StringRef Path = Input->getName();
Rafael Espindola7775c332016-08-26 20:19:35 +0000458 OS << Path << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000459 auto ResI = Res.begin();
460 for (const InputFile::Symbol &Sym : Input->symbols()) {
461 assert(ResI != Res.end());
462 SymbolResolution Res = *ResI++;
463
Rafael Espindola7775c332016-08-26 20:19:35 +0000464 OS << "-r=" << Path << ',' << Sym.getName() << ',';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000465 if (Res.Prevailing)
Rafael Espindola7775c332016-08-26 20:19:35 +0000466 OS << 'p';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000467 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola7775c332016-08-26 20:19:35 +0000468 OS << 'l';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000469 if (Res.VisibleToRegularObj)
Rafael Espindola7775c332016-08-26 20:19:35 +0000470 OS << 'x';
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000471 if (Res.LinkerRedefined)
472 OS << 'r';
Rafael Espindola7775c332016-08-26 20:19:35 +0000473 OS << '\n';
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000474 }
Peter Collingbourne58ffcfb2017-01-19 23:10:14 +0000475 OS.flush();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000476 assert(ResI == Res.end());
477}
478
479Error LTO::add(std::unique_ptr<InputFile> Input,
480 ArrayRef<SymbolResolution> Res) {
481 assert(!CalledGetMaxTasks);
482
483 if (Conf.ResolutionFile)
Rafael Espindola7775c332016-08-26 20:19:35 +0000484 writeToResolutionFile(*Conf.ResolutionFile, Input.get(), Res);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000485
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000486 if (RegularLTO.CombinedModule->getTargetTriple().empty())
487 RegularLTO.CombinedModule->setTargetTriple(Input->getTargetTriple());
488
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000489 const SymbolResolution *ResI = Res.begin();
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000490 for (unsigned I = 0; I != Input->Mods.size(); ++I)
491 if (Error Err = addModule(*Input, I, ResI, Res.end()))
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000492 return Err;
493
494 assert(ResI == Res.end());
495 return Error::success();
496}
497
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000498Error LTO::addModule(InputFile &Input, unsigned ModI,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000499 const SymbolResolution *&ResI,
500 const SymbolResolution *ResE) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000501 Expected<BitcodeLTOInfo> LTOInfo = Input.Mods[ModI].getLTOInfo();
502 if (!LTOInfo)
503 return LTOInfo.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000504
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000505 BitcodeModule BM = Input.Mods[ModI];
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000506 auto ModSyms = Input.module_symbols(ModI);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000507 addModuleToGlobalRes(ModSyms, {ResI, ResE},
508 LTOInfo->IsThinLTO ? ThinLTO.ModuleMap.size() + 1 : 0,
509 LTOInfo->HasSummary);
510
511 if (LTOInfo->IsThinLTO)
512 return addThinLTO(BM, ModSyms, ResI, ResE);
513
514 Expected<RegularLTOState::AddedModule> ModOrErr =
515 addRegularLTO(BM, ModSyms, ResI, ResE);
516 if (!ModOrErr)
517 return ModOrErr.takeError();
518
519 if (!LTOInfo->HasSummary)
520 return linkRegularLTO(std::move(*ModOrErr), /*LivenessFromIndex=*/false);
521
522 // Regular LTO module summaries are added to a dummy module that represents
523 // the combined regular LTO module.
524 if (Error Err = BM.readSummary(ThinLTO.CombinedIndex, "", -1ull))
525 return Err;
526 RegularLTO.ModsWithSummaries.push_back(std::move(*ModOrErr));
527 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000528}
529
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000530// Checks whether the given global value is in a non-prevailing comdat
531// (comdat containing values the linker indicated were not prevailing,
532// which we then dropped to available_externally), and if so, removes
533// it from the comdat. This is called for all global values to ensure the
534// comdat is empty rather than leaving an incomplete comdat. It is needed for
535// regular LTO modules, in case we are in a mixed-LTO mode (both regular
536// and thin LTO modules) compilation. Since the regular LTO module will be
537// linked first in the final native link, we want to make sure the linker
538// doesn't select any of these incomplete comdats that would be left
539// in the regular LTO module without this cleanup.
540static void
541handleNonPrevailingComdat(GlobalValue &GV,
542 std::set<const Comdat *> &NonPrevailingComdats) {
543 Comdat *C = GV.getComdat();
544 if (!C)
545 return;
546
547 if (!NonPrevailingComdats.count(C))
548 return;
549
550 // Additionally need to drop externally visible global values from the comdat
551 // to available_externally, so that there aren't multiply defined linker
552 // errors.
553 if (!GV.hasLocalLinkage())
554 GV.setLinkage(GlobalValue::AvailableExternallyLinkage);
555
556 if (auto GO = dyn_cast<GlobalObject>(&GV))
557 GO->setComdat(nullptr);
558}
559
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000560// Add a regular LTO object to the link.
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000561// The resulting module needs to be linked into the combined LTO module with
562// linkRegularLTO.
563Expected<LTO::RegularLTOState::AddedModule>
564LTO::addRegularLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
565 const SymbolResolution *&ResI,
566 const SymbolResolution *ResE) {
567 RegularLTOState::AddedModule Mod;
Peter Collingbournead903692016-12-13 19:43:49 +0000568 Expected<std::unique_ptr<Module>> MOrErr =
Teresa Johnsona61f5e32016-12-16 21:25:01 +0000569 BM.getLazyModule(RegularLTO.Ctx, /*ShouldLazyLoadMetadata*/ true,
570 /*IsImporting*/ false);
Peter Collingbournead903692016-12-13 19:43:49 +0000571 if (!MOrErr)
572 return MOrErr.takeError();
Peter Collingbournead903692016-12-13 19:43:49 +0000573 Module &M = **MOrErr;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000574 Mod.M = std::move(*MOrErr);
575
Peter Collingbourne7f00d0a2016-11-09 17:49:19 +0000576 if (Error Err = M.materializeMetadata())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000577 return std::move(Err);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000578 UpgradeDebugInfo(M);
579
Peter Collingbournead903692016-12-13 19:43:49 +0000580 ModuleSymbolTable SymTab;
581 SymTab.addModule(&M);
582
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000583 for (GlobalVariable &GV : M.globals())
584 if (GV.hasAppendingLinkage())
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000585 Mod.Keep.push_back(&GV);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000586
Peter Collingbourne46136262017-02-02 05:22:42 +0000587 DenseSet<GlobalObject *> AliasedGlobals;
588 for (auto &GA : M.aliases())
589 if (GlobalObject *GO = GA.getBaseObject())
590 AliasedGlobals.insert(GO);
591
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000592 // In this function we need IR GlobalValues matching the symbols in Syms
593 // (which is not backed by a module), so we need to enumerate them in the same
594 // order. The symbol enumeration order of a ModuleSymbolTable intentionally
595 // matches the order of an irsymtab, but when we read the irsymtab in
596 // InputFile::create we omit some symbols that are irrelevant to LTO. The
597 // Skip() function skips the same symbols from the module as InputFile does
598 // from the symbol table.
599 auto MsymI = SymTab.symbols().begin(), MsymE = SymTab.symbols().end();
600 auto Skip = [&]() {
601 while (MsymI != MsymE) {
602 auto Flags = SymTab.getSymbolFlags(*MsymI);
603 if ((Flags & object::BasicSymbolRef::SF_Global) &&
604 !(Flags & object::BasicSymbolRef::SF_FormatSpecific))
605 return;
606 ++MsymI;
607 }
608 };
609 Skip();
610
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000611 std::set<const Comdat *> NonPrevailingComdats;
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000612 for (const InputFile::Symbol &Sym : Syms) {
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000613 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000614 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000615
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000616 assert(MsymI != MsymE);
617 ModuleSymbolTable::Symbol Msym = *MsymI++;
618 Skip();
619
620 if (GlobalValue *GV = Msym.dyn_cast<GlobalValue *>()) {
Peter Collingbournec387e702017-02-02 05:12:15 +0000621 if (Res.Prevailing) {
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000622 if (Sym.isUndefined())
Peter Collingbournec387e702017-02-02 05:12:15 +0000623 continue;
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000624 Mod.Keep.push_back(GV);
Dmitry Mikulindb3b87b2017-06-05 16:24:25 +0000625 // For symbols re-defined with linker -wrap and -defsym options,
626 // set the linkage to weak to inhibit IPO. The linkage will be
627 // restored by the linker.
628 if (Res.LinkerRedefined)
629 GV->setLinkage(GlobalValue::WeakAnyLinkage);
630
Davide Italianod4db1162017-05-26 21:56:14 +0000631 GlobalValue::LinkageTypes OriginalLinkage = GV->getLinkage();
632 if (GlobalValue::isLinkOnceLinkage(OriginalLinkage))
633 GV->setLinkage(GlobalValue::getWeakLinkage(
634 GlobalValue::isLinkOnceODRLinkage(OriginalLinkage)));
Peter Collingbourne46136262017-02-02 05:22:42 +0000635 } else if (isa<GlobalObject>(GV) &&
636 (GV->hasLinkOnceODRLinkage() || GV->hasWeakODRLinkage() ||
637 GV->hasAvailableExternallyLinkage()) &&
638 !AliasedGlobals.count(cast<GlobalObject>(GV))) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000639 // Any of the above three types of linkage indicates that the
Peter Collingbourne46136262017-02-02 05:22:42 +0000640 // chosen prevailing symbol will have the same semantics as this copy of
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000641 // the symbol, so we may be able to link it with available_externally
642 // linkage. We will decide later whether to do that when we link this
643 // module (in linkRegularLTO), based on whether it is undefined.
644 Mod.Keep.push_back(GV);
645 GV->setLinkage(GlobalValue::AvailableExternallyLinkage);
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000646 if (GV->hasComdat())
647 NonPrevailingComdats.insert(GV->getComdat());
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000648 cast<GlobalObject>(GV)->setComdat(nullptr);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000649 }
Sean Fertile4595a912017-11-04 17:04:39 +0000650
651 // Set the 'local' flag based on the linker resolution for this symbol.
Rafael Espindola8a1ca672018-01-18 05:38:43 +0000652 if (Res.FinalDefinitionInLinkageUnit)
Rafael Espindola349fe0a2018-01-24 19:11:24 +0000653 GV->setDSOLocal(true);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000654 }
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000655 // Common resolution: collect the maximum size/alignment over all commons.
656 // We also record if we see an instance of a common as prevailing, so that
657 // if none is prevailing we can ignore it later.
Peter Collingbourne0d56b952017-03-28 22:31:35 +0000658 if (Sym.isCommon()) {
Peter Collingbournefb8c2a42016-12-01 02:51:12 +0000659 // FIXME: We should figure out what to do about commons defined by asm.
660 // For now they aren't reported correctly by ModuleSymbolTable.
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000661 auto &CommonRes = RegularLTO.Commons[Sym.getIRName()];
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000662 CommonRes.Size = std::max(CommonRes.Size, Sym.getCommonSize());
663 CommonRes.Align = std::max(CommonRes.Align, Sym.getCommonAlignment());
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000664 CommonRes.Prevailing |= Res.Prevailing;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000665 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000666
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000667 }
Teresa Johnsonb247ffb2017-06-30 14:03:24 +0000668 if (!M.getComdatSymbolTable().empty())
669 for (GlobalValue &GV : M.global_values())
670 handleNonPrevailingComdat(GV, NonPrevailingComdats);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000671 assert(MsymI == MsymE);
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000672 return std::move(Mod);
673}
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000674
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000675Error LTO::linkRegularLTO(RegularLTOState::AddedModule Mod,
676 bool LivenessFromIndex) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000677 std::vector<GlobalValue *> Keep;
678 for (GlobalValue *GV : Mod.Keep) {
679 if (LivenessFromIndex && !ThinLTO.CombinedIndex.isGUIDLive(GV->getGUID()))
680 continue;
681
682 if (!GV->hasAvailableExternallyLinkage()) {
683 Keep.push_back(GV);
684 continue;
685 }
686
687 // Only link available_externally definitions if we don't already have a
688 // definition.
689 GlobalValue *CombinedGV =
690 RegularLTO.CombinedModule->getNamedValue(GV->getName());
691 if (CombinedGV && !CombinedGV->isDeclaration())
692 continue;
693
694 Keep.push_back(GV);
695 }
696
697 return RegularLTO.Mover->move(std::move(Mod.M), Keep,
Teresa Johnson4b9b3792016-10-12 18:39:29 +0000698 [](GlobalValue &, IRMover::ValueAdder) {},
Teresa Johnson040cc162016-12-12 16:09:30 +0000699 /* IsPerformingImport */ false);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000700}
701
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000702// Add a ThinLTO module to the link.
703Error LTO::addThinLTO(BitcodeModule BM, ArrayRef<InputFile::Symbol> Syms,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000704 const SymbolResolution *&ResI,
705 const SymbolResolution *ResE) {
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000706 if (Error Err =
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000707 BM.readSummary(ThinLTO.CombinedIndex, BM.getModuleIdentifier(),
708 ThinLTO.ModuleMap.size()))
Peter Collingbourne74d22dd2017-05-01 22:04:36 +0000709 return Err;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000710
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000711 for (const InputFile::Symbol &Sym : Syms) {
712 assert(ResI != ResE);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000713 SymbolResolution Res = *ResI++;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000714
Sean Fertile4595a912017-11-04 17:04:39 +0000715 if (!Sym.getIRName().empty()) {
716 auto GUID = GlobalValue::getGUID(GlobalValue::getGlobalIdentifier(
717 Sym.getIRName(), GlobalValue::ExternalLinkage, ""));
718 if (Res.Prevailing) {
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000719 ThinLTO.PrevailingModuleForGUID[GUID] = BM.getModuleIdentifier();
Davide Italiano6a5fbe52017-07-06 19:58:26 +0000720
721 // For linker redefined symbols (via --wrap or --defsym) we want to
722 // switch the linkage to `weak` to prevent IPOs from happening.
723 // Find the summary in the module for this very GV and record the new
724 // linkage so that we can switch it when we import the GV.
725 if (Res.LinkerRedefined)
726 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
727 GUID, BM.getModuleIdentifier()))
728 S->setLinkage(GlobalValue::WeakAnyLinkage);
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000729 }
Sean Fertile4595a912017-11-04 17:04:39 +0000730
731 // If the linker resolved the symbol to a local definition then mark it
732 // as local in the summary for the module we are adding.
733 if (Res.FinalDefinitionInLinkageUnit) {
734 if (auto S = ThinLTO.CombinedIndex.findSummaryInModule(
735 GUID, BM.getModuleIdentifier())) {
736 S->setDSOLocal(true);
737 }
738 }
Peter Collingbourne7b30f162017-03-31 04:47:07 +0000739 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000740 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000741
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000742 if (!ThinLTO.ModuleMap.insert({BM.getModuleIdentifier(), BM}).second)
743 return make_error<StringError>(
744 "Expected at most one ThinLTO module per bitcode file",
745 inconvertibleErrorCode());
746
Mehdi Amini41af4302016-11-11 04:28:40 +0000747 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000748}
749
Teresa Johnsonfaa75062016-08-11 20:38:39 +0000750unsigned LTO::getMaxTasks() const {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000751 CalledGetMaxTasks = true;
752 return RegularLTO.ParallelCodeGenParallelismLevel + ThinLTO.ModuleMap.size();
753}
754
Peter Collingbourne80186a52016-09-23 21:33:43 +0000755Error LTO::run(AddStreamFn AddStream, NativeObjectCache Cache) {
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000756 // Compute "dead" symbols, we don't want to import/export these!
757 DenseSet<GlobalValue::GUID> GUIDPreservedSymbols;
George Rimareaf51722018-01-29 08:03:30 +0000758 DenseMap<GlobalValue::GUID, PrevailingType> GUIDPrevailingResolutions;
759 for (auto &Res : GlobalResolutions) {
760 // Normally resolution have IR name of symbol. We can do nothing here
761 // otherwise. See comments in GlobalResolution struct for more details.
762 if (Res.second.IRName.empty())
763 continue;
764
765 GlobalValue::GUID GUID = GlobalValue::getGUID(
766 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
767
George Rimard3283652018-01-25 17:23:27 +0000768 if (Res.second.VisibleOutsideSummary && Res.second.Prevailing)
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000769 GUIDPreservedSymbols.insert(GlobalValue::getGUID(
770 GlobalValue::dropLLVMManglingEscape(Res.second.IRName)));
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000771
George Rimareaf51722018-01-29 08:03:30 +0000772 GUIDPrevailingResolutions[GUID] =
773 Res.second.Prevailing ? PrevailingType::Yes : PrevailingType::No;
774 }
775
776 auto isPrevailing = [&](GlobalValue::GUID G) {
777 auto It = GUIDPrevailingResolutions.find(G);
778 if (It == GUIDPrevailingResolutions.end())
779 return PrevailingType::Unknown;
780 return It->second;
781 };
782 computeDeadSymbols(ThinLTO.CombinedIndex, GUIDPreservedSymbols, isPrevailing);
Evgeniy Stepanov659b3bc2017-06-02 18:24:17 +0000783
Vitaly Bukaa5376f32017-12-16 02:10:00 +0000784 if (auto E = runRegularLTO(AddStream))
785 return E;
786 return runThinLTO(AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000787}
788
Peter Collingbourne80186a52016-09-23 21:33:43 +0000789Error LTO::runRegularLTO(AddStreamFn AddStream) {
Peter Collingbournedbd2fed2017-06-15 17:26:13 +0000790 for (auto &M : RegularLTO.ModsWithSummaries)
791 if (Error Err = linkRegularLTO(std::move(M),
792 /*LivenessFromIndex=*/true))
793 return Err;
794
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000795 // Make sure commons have the right size/alignment: we kept the largest from
796 // all the prevailing when adding the inputs, and we apply it here.
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000797 const DataLayout &DL = RegularLTO.CombinedModule->getDataLayout();
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000798 for (auto &I : RegularLTO.Commons) {
Mehdi Aminib2f46d1d2016-09-14 21:05:04 +0000799 if (!I.second.Prevailing)
800 // Don't do anything if no instance of this common was prevailing.
801 continue;
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000802 GlobalVariable *OldGV = RegularLTO.CombinedModule->getNamedGlobal(I.first);
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000803 if (OldGV && DL.getTypeAllocSize(OldGV->getValueType()) == I.second.Size) {
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000804 // Don't create a new global if the type is already correct, just make
805 // sure the alignment is correct.
806 OldGV->setAlignment(I.second.Align);
807 continue;
808 }
Teresa Johnsone2e621a2016-08-27 04:41:22 +0000809 ArrayType *Ty =
810 ArrayType::get(Type::getInt8Ty(RegularLTO.Ctx), I.second.Size);
Mehdi Aminidc4c8cf2016-08-22 06:25:46 +0000811 auto *GV = new GlobalVariable(*RegularLTO.CombinedModule, Ty, false,
812 GlobalValue::CommonLinkage,
813 ConstantAggregateZero::get(Ty), "");
814 GV->setAlignment(I.second.Align);
815 if (OldGV) {
816 OldGV->replaceAllUsesWith(ConstantExpr::getBitCast(GV, OldGV->getType()));
817 GV->takeName(OldGV);
818 OldGV->eraseFromParent();
819 } else {
820 GV->setName(I.first);
821 }
822 }
823
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000824 if (Conf.PreOptModuleHook &&
825 !Conf.PreOptModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000826 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000827
Mehdi Aminid310b472016-08-22 06:25:41 +0000828 if (!Conf.CodeGenOnly) {
829 for (const auto &R : GlobalResolutions) {
George Rimareaf51722018-01-29 08:03:30 +0000830 if (!R.second.isPrevailingIRSymbol())
Mehdi Aminid310b472016-08-22 06:25:41 +0000831 continue;
832 if (R.second.Partition != 0 &&
833 R.second.Partition != GlobalResolution::External)
834 continue;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000835
Mehdi Aminid310b472016-08-22 06:25:41 +0000836 GlobalValue *GV =
837 RegularLTO.CombinedModule->getNamedValue(R.second.IRName);
838 // Ignore symbols defined in other partitions.
839 if (!GV || GV->hasLocalLinkage())
840 continue;
841 GV->setUnnamedAddr(R.second.UnnamedAddr ? GlobalValue::UnnamedAddr::Global
842 : GlobalValue::UnnamedAddr::None);
843 if (R.second.Partition == 0)
844 GV->setLinkage(GlobalValue::InternalLinkage);
845 }
846
847 if (Conf.PostInternalizeModuleHook &&
848 !Conf.PostInternalizeModuleHook(0, *RegularLTO.CombinedModule))
Mehdi Amini41af4302016-11-11 04:28:40 +0000849 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000850 }
Peter Collingbourne80186a52016-09-23 21:33:43 +0000851 return backend(Conf, AddStream, RegularLTO.ParallelCodeGenParallelismLevel,
Peter Collingbournee02b74e2017-01-20 22:18:52 +0000852 std::move(RegularLTO.CombinedModule), ThinLTO.CombinedIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000853}
854
855/// This class defines the interface to the ThinLTO backend.
856class lto::ThinBackendProc {
857protected:
858 Config &Conf;
859 ModuleSummaryIndex &CombinedIndex;
Mehdi Amini767e1452016-09-06 03:23:45 +0000860 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000861
862public:
863 ThinBackendProc(Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +0000864 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries)
Mehdi Amini18b91112016-08-19 06:10:03 +0000865 : Conf(Conf), CombinedIndex(CombinedIndex),
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000866 ModuleToDefinedGVSummaries(ModuleToDefinedGVSummaries) {}
867
868 virtual ~ThinBackendProc() {}
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000869 virtual Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000870 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000871 const FunctionImporter::ImportMapTy &ImportList,
872 const FunctionImporter::ExportSetTy &ExportList,
873 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000874 MapVector<StringRef, BitcodeModule> &ModuleMap) = 0;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000875 virtual Error wait() = 0;
876};
877
Benjamin Kramerffd37152016-11-19 20:44:26 +0000878namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000879class InProcessThinBackend : public ThinBackendProc {
880 ThreadPool BackendThreadPool;
Peter Collingbourne80186a52016-09-23 21:33:43 +0000881 AddStreamFn AddStream;
882 NativeObjectCache Cache;
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000883 TypeIdSummariesByGuidTy TypeIdSummariesByGuid;
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000884 std::set<GlobalValue::GUID> CfiFunctionDefs;
885 std::set<GlobalValue::GUID> CfiFunctionDecls;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000886
887 Optional<Error> Err;
888 std::mutex ErrMu;
889
890public:
Mehdi Amini767e1452016-09-06 03:23:45 +0000891 InProcessThinBackend(
892 Config &Conf, ModuleSummaryIndex &CombinedIndex,
893 unsigned ThinLTOParallelismLevel,
894 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +0000895 AddStreamFn AddStream, NativeObjectCache Cache)
Mehdi Amini18b91112016-08-19 06:10:03 +0000896 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
897 BackendThreadPool(ThinLTOParallelismLevel),
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000898 AddStream(std::move(AddStream)), Cache(std::move(Cache)) {
899 // Create a mapping from type identifier GUIDs to type identifier summaries.
900 // This allows backends to use the type identifier GUIDs stored in the
901 // function summaries to determine which type identifier summaries affect
902 // each function without needing to compute GUIDs in each backend.
903 for (auto &TId : CombinedIndex.typeIds())
904 TypeIdSummariesByGuid[GlobalValue::getGUID(TId.first)].push_back(&TId);
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000905 for (auto &Name : CombinedIndex.cfiFunctionDefs())
906 CfiFunctionDefs.insert(
907 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
908 for (auto &Name : CombinedIndex.cfiFunctionDecls())
909 CfiFunctionDecls.insert(
910 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Name)));
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000911 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000912
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000913 Error runThinLTOBackendThread(
Peter Collingbourne80186a52016-09-23 21:33:43 +0000914 AddStreamFn AddStream, NativeObjectCache Cache, unsigned Task,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000915 BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000916 const FunctionImporter::ImportMapTy &ImportList,
917 const FunctionImporter::ExportSetTy &ExportList,
918 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
919 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000920 MapVector<StringRef, BitcodeModule> &ModuleMap,
921 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Peter Collingbourne80186a52016-09-23 21:33:43 +0000922 auto RunThinBackend = [&](AddStreamFn AddStream) {
923 LTOLLVMContext BackendContext(Conf);
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000924 Expected<std::unique_ptr<Module>> MOrErr = BM.parseModule(BackendContext);
Peter Collingbourned9445c42016-11-13 07:00:17 +0000925 if (!MOrErr)
926 return MOrErr.takeError();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000927
Peter Collingbourne80186a52016-09-23 21:33:43 +0000928 return thinBackend(Conf, Task, AddStream, **MOrErr, CombinedIndex,
929 ImportList, DefinedGlobals, ModuleMap);
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000930 };
Peter Collingbourne80186a52016-09-23 21:33:43 +0000931
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000932 auto ModuleID = BM.getModuleIdentifier();
Mehdi Aminif82bda02016-10-08 04:44:23 +0000933
934 if (!Cache || !CombinedIndex.modulePaths().count(ModuleID) ||
935 all_of(CombinedIndex.getModuleHash(ModuleID),
936 [](uint32_t V) { return V == 0; }))
937 // Cache disabled or no entry for this module in the combined index or
938 // no module hash.
Peter Collingbourne80186a52016-09-23 21:33:43 +0000939 return RunThinBackend(AddStream);
940
941 SmallString<40> Key;
942 // The module may be cached, this helps handling it.
Peter Collingbournef4257522016-12-08 05:28:30 +0000943 computeCacheKey(Key, Conf, CombinedIndex, ModuleID, ImportList, ExportList,
Evgeniy Stepanov3427d172017-08-09 23:24:07 +0000944 ResolvedODR, DefinedGlobals, TypeIdSummariesByGuid,
945 CfiFunctionDefs, CfiFunctionDecls);
Peter Collingbourne80186a52016-09-23 21:33:43 +0000946 if (AddStreamFn CacheAddStream = Cache(Task, Key))
947 return RunThinBackend(CacheAddStream);
948
Mehdi Amini41af4302016-11-11 04:28:40 +0000949 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000950 }
951
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000952 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000953 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000954 const FunctionImporter::ImportMapTy &ImportList,
955 const FunctionImporter::ExportSetTy &ExportList,
956 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000957 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
958 StringRef ModulePath = BM.getModuleIdentifier();
Mehdi Amini767e1452016-09-06 03:23:45 +0000959 assert(ModuleToDefinedGVSummaries.count(ModulePath));
960 const GVSummaryMapTy &DefinedGlobals =
961 ModuleToDefinedGVSummaries.find(ModulePath)->second;
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000962 BackendThreadPool.async(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +0000963 [=](BitcodeModule BM, ModuleSummaryIndex &CombinedIndex,
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000964 const FunctionImporter::ImportMapTy &ImportList,
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000965 const FunctionImporter::ExportSetTy &ExportList,
966 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>
967 &ResolvedODR,
Mehdi Amini767e1452016-09-06 03:23:45 +0000968 const GVSummaryMapTy &DefinedGlobals,
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000969 MapVector<StringRef, BitcodeModule> &ModuleMap,
970 const TypeIdSummariesByGuidTy &TypeIdSummariesByGuid) {
Mehdi Aminiadc0e262016-08-23 21:30:12 +0000971 Error E = runThinLTOBackendThread(
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000972 AddStream, Cache, Task, BM, CombinedIndex, ImportList, ExportList,
973 ResolvedODR, DefinedGlobals, ModuleMap, TypeIdSummariesByGuid);
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000974 if (E) {
975 std::unique_lock<std::mutex> L(ErrMu);
976 if (Err)
977 Err = joinErrors(std::move(*Err), std::move(E));
978 else
979 Err = std::move(E);
980 }
981 },
Peter Collingbourne780a4dd2017-03-10 21:35:17 +0000982 BM, std::ref(CombinedIndex), std::ref(ImportList), std::ref(ExportList),
983 std::ref(ResolvedODR), std::ref(DefinedGlobals), std::ref(ModuleMap),
984 std::ref(TypeIdSummariesByGuid));
Mehdi Amini41af4302016-11-11 04:28:40 +0000985 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000986 }
987
988 Error wait() override {
989 BackendThreadPool.wait();
990 if (Err)
991 return std::move(*Err);
992 else
Mehdi Amini41af4302016-11-11 04:28:40 +0000993 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000994 }
995};
Benjamin Kramerffd37152016-11-19 20:44:26 +0000996} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +0000997
998ThinBackend lto::createInProcessThinBackend(unsigned ParallelismLevel) {
999 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001000 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001001 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001002 return llvm::make_unique<InProcessThinBackend>(
1003 Conf, CombinedIndex, ParallelismLevel, ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001004 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001005 };
1006}
1007
Teresa Johnson3f212b82016-09-21 19:12:05 +00001008// Given the original \p Path to an output file, replace any path
1009// prefix matching \p OldPrefix with \p NewPrefix. Also, create the
1010// resulting directory if it does not yet exist.
1011std::string lto::getThinLTOOutputFile(const std::string &Path,
1012 const std::string &OldPrefix,
1013 const std::string &NewPrefix) {
1014 if (OldPrefix.empty() && NewPrefix.empty())
1015 return Path;
1016 SmallString<128> NewPath(Path);
1017 llvm::sys::path::replace_path_prefix(NewPath, OldPrefix, NewPrefix);
1018 StringRef ParentPath = llvm::sys::path::parent_path(NewPath.str());
1019 if (!ParentPath.empty()) {
1020 // Make sure the new directory exists, creating it if necessary.
1021 if (std::error_code EC = llvm::sys::fs::create_directories(ParentPath))
1022 llvm::errs() << "warning: could not create directory '" << ParentPath
1023 << "': " << EC.message() << '\n';
1024 }
1025 return NewPath.str();
1026}
1027
Benjamin Kramerffd37152016-11-19 20:44:26 +00001028namespace {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001029class WriteIndexesThinBackend : public ThinBackendProc {
1030 std::string OldPrefix, NewPrefix;
1031 bool ShouldEmitImportsFiles;
1032
1033 std::string LinkedObjectsFileName;
1034 std::unique_ptr<llvm::raw_fd_ostream> LinkedObjectsFile;
1035
Vitaly Buka59baf732018-01-30 21:19:26 +00001036 lto::IndexWriteCallback OnWrite;
1037
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001038public:
Mehdi Amini767e1452016-09-06 03:23:45 +00001039 WriteIndexesThinBackend(
1040 Config &Conf, ModuleSummaryIndex &CombinedIndex,
1041 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
1042 std::string OldPrefix, std::string NewPrefix, bool ShouldEmitImportsFiles,
Vitaly Buka59baf732018-01-30 21:19:26 +00001043 std::string LinkedObjectsFileName, lto::IndexWriteCallback OnWrite)
Mehdi Amini18b91112016-08-19 06:10:03 +00001044 : ThinBackendProc(Conf, CombinedIndex, ModuleToDefinedGVSummaries),
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001045 OldPrefix(OldPrefix), NewPrefix(NewPrefix),
1046 ShouldEmitImportsFiles(ShouldEmitImportsFiles),
Vitaly Buka59baf732018-01-30 21:19:26 +00001047 LinkedObjectsFileName(LinkedObjectsFileName), OnWrite(OnWrite) {}
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001048
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001049 Error start(
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001050 unsigned Task, BitcodeModule BM,
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001051 const FunctionImporter::ImportMapTy &ImportList,
1052 const FunctionImporter::ExportSetTy &ExportList,
1053 const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
Peter Collingbourne1a0720e2016-12-14 01:17:59 +00001054 MapVector<StringRef, BitcodeModule> &ModuleMap) override {
1055 StringRef ModulePath = BM.getModuleIdentifier();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001056 std::string NewModulePath =
1057 getThinLTOOutputFile(ModulePath, OldPrefix, NewPrefix);
1058
1059 std::error_code EC;
1060 if (!LinkedObjectsFileName.empty()) {
1061 if (!LinkedObjectsFile) {
1062 LinkedObjectsFile = llvm::make_unique<raw_fd_ostream>(
1063 LinkedObjectsFileName, EC, sys::fs::OpenFlags::F_None);
1064 if (EC)
1065 return errorCodeToError(EC);
1066 }
1067 *LinkedObjectsFile << NewModulePath << '\n';
1068 }
1069
1070 std::map<std::string, GVSummaryMapTy> ModuleToSummariesForIndex;
1071 gatherImportedSummariesForModule(ModulePath, ModuleToDefinedGVSummaries,
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001072 ImportList, ModuleToSummariesForIndex);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001073
1074 raw_fd_ostream OS(NewModulePath + ".thinlto.bc", EC,
1075 sys::fs::OpenFlags::F_None);
1076 if (EC)
1077 return errorCodeToError(EC);
1078 WriteIndexToFile(CombinedIndex, OS, &ModuleToSummariesForIndex);
1079
Vitaly Buka59baf732018-01-30 21:19:26 +00001080 if (ShouldEmitImportsFiles) {
1081 EC = EmitImportsFiles(ModulePath, NewModulePath + ".imports", ImportList);
1082 if (EC)
1083 return errorCodeToError(EC);
1084 }
1085
1086 if (OnWrite)
1087 OnWrite(ModulePath);
Mehdi Amini41af4302016-11-11 04:28:40 +00001088 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001089 }
1090
Mehdi Amini41af4302016-11-11 04:28:40 +00001091 Error wait() override { return Error::success(); }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001092};
Benjamin Kramerffd37152016-11-19 20:44:26 +00001093} // end anonymous namespace
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001094
1095ThinBackend lto::createWriteIndexesThinBackend(std::string OldPrefix,
1096 std::string NewPrefix,
1097 bool ShouldEmitImportsFiles,
Vitaly Buka59baf732018-01-30 21:19:26 +00001098 std::string LinkedObjectsFile,
1099 IndexWriteCallback OnWrite) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001100 return [=](Config &Conf, ModuleSummaryIndex &CombinedIndex,
Mehdi Amini767e1452016-09-06 03:23:45 +00001101 const StringMap<GVSummaryMapTy> &ModuleToDefinedGVSummaries,
Peter Collingbourne80186a52016-09-23 21:33:43 +00001102 AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001103 return llvm::make_unique<WriteIndexesThinBackend>(
Mehdi Amini18b91112016-08-19 06:10:03 +00001104 Conf, CombinedIndex, ModuleToDefinedGVSummaries, OldPrefix, NewPrefix,
Vitaly Buka59baf732018-01-30 21:19:26 +00001105 ShouldEmitImportsFiles, LinkedObjectsFile, OnWrite);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001106 };
1107}
1108
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001109Error LTO::runThinLTO(AddStreamFn AddStream, NativeObjectCache Cache) {
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001110 if (ThinLTO.ModuleMap.empty())
Mehdi Amini41af4302016-11-11 04:28:40 +00001111 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001112
1113 if (Conf.CombinedIndexHook && !Conf.CombinedIndexHook(ThinLTO.CombinedIndex))
Mehdi Amini41af4302016-11-11 04:28:40 +00001114 return Error::success();
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001115
1116 // Collect for each module the list of function it defines (GUID ->
1117 // Summary).
Dehao Chen5d96ee42017-07-10 20:12:54 +00001118 StringMap<GVSummaryMapTy>
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001119 ModuleToDefinedGVSummaries(ThinLTO.ModuleMap.size());
1120 ThinLTO.CombinedIndex.collectDefinedGVSummariesPerModule(
1121 ModuleToDefinedGVSummaries);
Teresa Johnson620c1402016-09-20 23:07:17 +00001122 // Create entries for any modules that didn't have any GV summaries
1123 // (either they didn't have any GVs to start with, or we suppressed
1124 // generation of the summaries because they e.g. had inline assembly
1125 // uses that couldn't be promoted/renamed on export). This is so
1126 // InProcessThinBackend::start can still launch a backend thread, which
1127 // is passed the map of summaries for the module, without any special
1128 // handling for this case.
1129 for (auto &Mod : ThinLTO.ModuleMap)
1130 if (!ModuleToDefinedGVSummaries.count(Mod.first))
1131 ModuleToDefinedGVSummaries.try_emplace(Mod.first);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001132
1133 StringMap<FunctionImporter::ImportMapTy> ImportLists(
1134 ThinLTO.ModuleMap.size());
1135 StringMap<FunctionImporter::ExportSetTy> ExportLists(
1136 ThinLTO.ModuleMap.size());
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001137 StringMap<std::map<GlobalValue::GUID, GlobalValue::LinkageTypes>> ResolvedODR;
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001138
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001139 if (Conf.OptLevel > 0)
Teresa Johnson002af9b2016-10-31 22:12:21 +00001140 ComputeCrossModuleImport(ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
Evgeniy Stepanov56584bb2017-06-01 20:30:06 +00001141 ImportLists, ExportLists);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001142
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001143 // Figure out which symbols need to be internalized. This also needs to happen
1144 // at -O0 because summary-based DCE is implemented using internalization, and
1145 // we must apply DCE consistently with the full LTO module in order to avoid
1146 // undefined references during the final link.
1147 std::set<GlobalValue::GUID> ExportedGUIDs;
1148 for (auto &Res : GlobalResolutions) {
George Rimard3283652018-01-25 17:23:27 +00001149 // If the symbol does not have external references or it is not prevailing,
1150 // then not need to mark it as exported from a ThinLTO partition.
1151 if (Res.second.Partition != GlobalResolution::External ||
George Rimareaf51722018-01-29 08:03:30 +00001152 !Res.second.isPrevailingIRSymbol())
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001153 continue;
1154 auto GUID = GlobalValue::getGUID(
1155 GlobalValue::dropLLVMManglingEscape(Res.second.IRName));
1156 // Mark exported unless index-based analysis determined it to be dead.
1157 if (ThinLTO.CombinedIndex.isGUIDLive(GUID))
1158 ExportedGUIDs.insert(GUID);
Teresa Johnson002af9b2016-10-31 22:12:21 +00001159 }
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001160
Peter Collingbourne9fb6e1a2017-11-01 17:58:39 +00001161 // Any functions referenced by the jump table in the regular LTO object must
1162 // be exported.
1163 for (auto &Def : ThinLTO.CombinedIndex.cfiFunctionDefs())
1164 ExportedGUIDs.insert(
1165 GlobalValue::getGUID(GlobalValue::dropLLVMManglingEscape(Def)));
1166
1167 auto isExported = [&](StringRef ModuleIdentifier, GlobalValue::GUID GUID) {
1168 const auto &ExportList = ExportLists.find(ModuleIdentifier);
1169 return (ExportList != ExportLists.end() &&
1170 ExportList->second.count(GUID)) ||
1171 ExportedGUIDs.count(GUID);
1172 };
1173 thinLTOInternalizeAndPromoteInIndex(ThinLTO.CombinedIndex, isExported);
1174
Peter Collingbournef87197a2017-05-25 23:40:11 +00001175 auto isPrevailing = [&](GlobalValue::GUID GUID,
1176 const GlobalValueSummary *S) {
1177 return ThinLTO.PrevailingModuleForGUID[GUID] == S->modulePath();
1178 };
1179 auto recordNewLinkage = [&](StringRef ModuleIdentifier,
1180 GlobalValue::GUID GUID,
1181 GlobalValue::LinkageTypes NewLinkage) {
1182 ResolvedODR[ModuleIdentifier][GUID] = NewLinkage;
1183 };
1184 thinLTOResolveWeakForLinkerInIndex(ThinLTO.CombinedIndex, isPrevailing,
1185 recordNewLinkage);
1186
Peter Collingbourne80186a52016-09-23 21:33:43 +00001187 std::unique_ptr<ThinBackendProc> BackendProc =
1188 ThinLTO.Backend(Conf, ThinLTO.CombinedIndex, ModuleToDefinedGVSummaries,
1189 AddStream, Cache);
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001190
Vitaly Bukaa5376f32017-12-16 02:10:00 +00001191 // Tasks 0 through ParallelCodeGenParallelismLevel-1 are reserved for combined
1192 // module and parallel code generation partitions.
1193 unsigned Task = RegularLTO.ParallelCodeGenParallelismLevel;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001194 for (auto &Mod : ThinLTO.ModuleMap) {
Mehdi Aminicdbcbf72016-08-16 05:46:05 +00001195 if (Error E = BackendProc->start(Task, Mod.second, ImportLists[Mod.first],
Mehdi Aminiadc0e262016-08-23 21:30:12 +00001196 ExportLists[Mod.first],
1197 ResolvedODR[Mod.first], ThinLTO.ModuleMap))
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001198 return E;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001199 ++Task;
Teresa Johnson9ba95f92016-08-11 14:58:12 +00001200 }
1201
1202 return BackendProc->wait();
Teresa Johnsondf6edc52016-05-23 22:54:06 +00001203}
Davide Italiano690ed9d2017-02-10 23:49:38 +00001204
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001205Expected<std::unique_ptr<ToolOutputFile>>
Davide Italiano690ed9d2017-02-10 23:49:38 +00001206lto::setupOptimizationRemarks(LLVMContext &Context,
1207 StringRef LTORemarksFilename,
1208 bool LTOPassRemarksWithHotness, int Count) {
1209 if (LTORemarksFilename.empty())
1210 return nullptr;
1211
1212 std::string Filename = LTORemarksFilename;
1213 if (Count != -1)
1214 Filename += ".thin." + llvm::utostr(Count) + ".yaml";
1215
1216 std::error_code EC;
1217 auto DiagnosticFile =
Reid Kleckner3fc649c2017-09-23 01:03:17 +00001218 llvm::make_unique<ToolOutputFile>(Filename, EC, sys::fs::F_None);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001219 if (EC)
1220 return errorCodeToError(EC);
1221 Context.setDiagnosticsOutputFile(
1222 llvm::make_unique<yaml::Output>(DiagnosticFile->os()));
1223 if (LTOPassRemarksWithHotness)
Brian Gesiak44e5f6c2017-06-30 18:13:59 +00001224 Context.setDiagnosticsHotnessRequested(true);
Davide Italiano690ed9d2017-02-10 23:49:38 +00001225 DiagnosticFile->keep();
1226 return std::move(DiagnosticFile);
1227}