159a5afa9SMikhail Glushenkov //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===//
2361e513dSReid Spencer //
3361e513dSReid Spencer //                     The LLVM Compiler Infrastructure
4361e513dSReid Spencer //
5f3ebc3f3SChris Lattner // This file is distributed under the University of Illinois Open Source
6f3ebc3f3SChris Lattner // License. See LICENSE.TXT for details.
7361e513dSReid Spencer //
8361e513dSReid Spencer //===----------------------------------------------------------------------===//
9361e513dSReid Spencer //
10361e513dSReid Spencer // This file implements the LLVM module linker.
11361e513dSReid Spencer //
12361e513dSReid Spencer //===----------------------------------------------------------------------===//
13361e513dSReid Spencer 
146cc07df4SChandler Carruth #include "llvm/Linker/Linker.h"
15caabe228SRafael Espindola #include "LinkDiagnosticInfo.h"
16ed0881b2SChandler Carruth #include "llvm-c/Linker.h"
1766f02413SBill Wendling #include "llvm/ADT/SetVector.h"
18caabe228SRafael Espindola #include "llvm/ADT/StringSet.h"
19d12b4a33SRafael Espindola #include "llvm/IR/DiagnosticPrinter.h"
20*9d2bfc48SRafael Espindola #include "llvm/IR/LLVMContext.h"
21361e513dSReid Spencer using namespace llvm;
22361e513dSReid Spencer 
23b1ed91f3SChris Lattner namespace {
24d12b4a33SRafael Espindola 
2518c89411SRafael Espindola /// This is an implementation class for the LinkModules function, which is the
2618c89411SRafael Espindola /// entrypoint for this file.
27b1ed91f3SChris Lattner class ModuleLinker {
28caabe228SRafael Espindola   IRMover &Mover;
290e309fe8SRafael Espindola   Module &SrcM;
30b1ed91f3SChris Lattner 
314b5ec263SRafael Espindola   SetVector<GlobalValue *> ValuesToLink;
32caabe228SRafael Espindola   StringSet<> Internalize;
334160f5d3SRafael Espindola 
34e868123dSDuncan P. N. Exon Smith   /// For symbol clashes, prefer those from Src.
35020d4fb1SArtem Belevich   unsigned Flags;
36e868123dSDuncan P. N. Exon Smith 
37c7ed52f2STeresa Johnson   /// Function index passed into ModuleLinker for using in function
38c7ed52f2STeresa Johnson   /// importing/exporting handling.
398220e8a8SMehdi Amini   const FunctionInfoIndex *ImportIndex;
40c7ed52f2STeresa Johnson 
41c7ed52f2STeresa Johnson   /// Function to import from source module, all other functions are
42c7ed52f2STeresa Johnson   /// imported as declarations instead of definitions.
43ffe2e4aaSMehdi Amini   DenseSet<const GlobalValue *> *ImportFunction;
44c7ed52f2STeresa Johnson 
45c7ed52f2STeresa Johnson   /// Set to true if the given FunctionInfoIndex contains any functions
46c7ed52f2STeresa Johnson   /// from this source module, in which case we must conservatively assume
47c7ed52f2STeresa Johnson   /// that any of its functions may be imported into another module
48c7ed52f2STeresa Johnson   /// as part of a different backend compilation process.
49af714765SRafael Espindola   bool HasExportedFunctions = false;
50c7ed52f2STeresa Johnson 
51caabe228SRafael Espindola   /// Used as the callback for lazy linking.
52caabe228SRafael Espindola   /// The mover has just hit GV and we have to decide if it, and other members
53caabe228SRafael Espindola   /// of the same comdat, should be linked. Every member to be linked is passed
54caabe228SRafael Espindola   /// to Add.
55caabe228SRafael Espindola   void addLazyFor(GlobalValue &GV, IRMover::ValueAdder Add);
56baa3bf8fSRafael Espindola 
57020d4fb1SArtem Belevich   bool shouldOverrideFromSrc() { return Flags & Linker::OverrideFromSrc; }
58020d4fb1SArtem Belevich   bool shouldLinkOnlyNeeded() { return Flags & Linker::LinkOnlyNeeded; }
59020d4fb1SArtem Belevich   bool shouldInternalizeLinkedSymbols() {
60020d4fb1SArtem Belevich     return Flags & Linker::InternalizeLinkedSymbols;
61020d4fb1SArtem Belevich   }
62020d4fb1SArtem Belevich 
63c7ed52f2STeresa Johnson   /// Check if we should promote the given local value to global scope.
64c7ed52f2STeresa Johnson   bool doPromoteLocalToGlobal(const GlobalValue *SGV);
65c7ed52f2STeresa Johnson 
66d12b4a33SRafael Espindola   bool shouldLinkFromSource(bool &LinkFromSrc, const GlobalValue &Dest,
67d12b4a33SRafael Espindola                             const GlobalValue &Src);
68dbb0bd1aSRafael Espindola 
69caabe228SRafael Espindola   /// Should we have mover and linker error diag info?
70b1ed91f3SChris Lattner   bool emitError(const Twine &Message) {
71*9d2bfc48SRafael Espindola     SrcM.getContext().diagnose(LinkDiagnosticInfo(DS_Error, Message));
72b1ed91f3SChris Lattner     return true;
73b1ed91f3SChris Lattner   }
74b1ed91f3SChris Lattner 
750e309fe8SRafael Espindola   bool getComdatLeader(Module &M, StringRef ComdatName,
76dad0a645SDavid Majnemer                        const GlobalVariable *&GVar);
77dad0a645SDavid Majnemer   bool computeResultingSelectionKind(StringRef ComdatName,
78dad0a645SDavid Majnemer                                      Comdat::SelectionKind Src,
79dad0a645SDavid Majnemer                                      Comdat::SelectionKind Dst,
80dad0a645SDavid Majnemer                                      Comdat::SelectionKind &Result,
81dad0a645SDavid Majnemer                                      bool &LinkFromSrc);
82dad0a645SDavid Majnemer   std::map<const Comdat *, std::pair<Comdat::SelectionKind, bool>>
83dad0a645SDavid Majnemer       ComdatsChosen;
84dad0a645SDavid Majnemer   bool getComdatResult(const Comdat *SrcC, Comdat::SelectionKind &SK,
85dad0a645SDavid Majnemer                        bool &LinkFromSrc);
862d5fb8caSTeresa Johnson   // Keep track of the global value members of each comdat in source.
872d5fb8caSTeresa Johnson   DenseMap<const Comdat *, std::vector<GlobalValue *>> ComdatMembers;
88dad0a645SDavid Majnemer 
8918c89411SRafael Espindola   /// Given a global in the source module, return the global in the
9018c89411SRafael Espindola   /// destination module that is being linked to, if any.
913e8bc6a8SRafael Espindola   GlobalValue *getLinkedToGlobal(const GlobalValue *SrcGV) {
92caabe228SRafael Espindola     Module &DstM = Mover.getModule();
93b1ed91f3SChris Lattner     // If the source has no name it can't link.  If it has local linkage,
94b1ed91f3SChris Lattner     // there is no name match-up going on.
95b098f0c1STeresa Johnson     if (!SrcGV->hasName() || GlobalValue::isLocalLinkage(getLinkage(SrcGV)))
962617dcceSCraig Topper       return nullptr;
97b1ed91f3SChris Lattner 
98b1ed91f3SChris Lattner     // Otherwise see if we have a match in the destination module's symtab.
990e309fe8SRafael Espindola     GlobalValue *DGV = DstM.getNamedValue(getName(SrcGV));
100c84f608bSRafael Espindola     if (!DGV)
101c84f608bSRafael Espindola       return nullptr;
102b1ed91f3SChris Lattner 
103b1ed91f3SChris Lattner     // If we found a global with the same name in the dest module, but it has
104b1ed91f3SChris Lattner     // internal linkage, we are really not doing any linkage here.
105b1ed91f3SChris Lattner     if (DGV->hasLocalLinkage())
1062617dcceSCraig Topper       return nullptr;
107b1ed91f3SChris Lattner 
108b1ed91f3SChris Lattner     // Otherwise, we do in fact link to the destination global.
109b1ed91f3SChris Lattner     return DGV;
110b1ed91f3SChris Lattner   }
111b1ed91f3SChris Lattner 
112baa3bf8fSRafael Espindola   bool linkIfNeeded(GlobalValue &GV);
113c7ed52f2STeresa Johnson 
114c7ed52f2STeresa Johnson   /// Helper methods to check if we are importing from or potentially
115c7ed52f2STeresa Johnson   /// exporting from the current source module.
116c7ed52f2STeresa Johnson   bool isPerformingImport() { return ImportFunction != nullptr; }
117c7ed52f2STeresa Johnson   bool isModuleExporting() { return HasExportedFunctions; }
118c7ed52f2STeresa Johnson 
119c7ed52f2STeresa Johnson   /// If we are importing from the source module, checks if we should
120c7ed52f2STeresa Johnson   /// import SGV as a definition, otherwise import as a declaration.
121c7ed52f2STeresa Johnson   bool doImportAsDefinition(const GlobalValue *SGV);
122c7ed52f2STeresa Johnson 
123c7ed52f2STeresa Johnson   /// Get the name for SGV that should be used in the linked destination
124c7ed52f2STeresa Johnson   /// module. Specifically, this handles the case where we need to rename
125c7ed52f2STeresa Johnson   /// a local that is being promoted to global scope.
126c7ed52f2STeresa Johnson   std::string getName(const GlobalValue *SGV);
127c7ed52f2STeresa Johnson 
128caabe228SRafael Espindola   /// Process globals so that they can be used in ThinLTO. This includes
129caabe228SRafael Espindola   /// promoting local variables so that they can be reference externally by
130caabe228SRafael Espindola   /// thin lto imported globals and converting strong external globals to
131caabe228SRafael Espindola   /// available_externally.
132caabe228SRafael Espindola   void processGlobalsForThinLTO();
133caabe228SRafael Espindola   void processGlobalForThinLTO(GlobalValue &GV);
134caabe228SRafael Espindola 
135c7ed52f2STeresa Johnson   /// Get the new linkage for SGV that should be used in the linked destination
136c7ed52f2STeresa Johnson   /// module. Specifically, for ThinLTO importing or exporting it may need
137c7ed52f2STeresa Johnson   /// to be adjusted.
138c7ed52f2STeresa Johnson   GlobalValue::LinkageTypes getLinkage(const GlobalValue *SGV);
139c7ed52f2STeresa Johnson 
140c7ed52f2STeresa Johnson   /// Copies the necessary global value attributes and name from the source
141c7ed52f2STeresa Johnson   /// to the newly cloned global value.
142c7ed52f2STeresa Johnson   void copyGVAttributes(GlobalValue *NewGV, const GlobalValue *SrcGV);
143c7ed52f2STeresa Johnson 
144c7ed52f2STeresa Johnson   /// Updates the visibility for the new global cloned from the source
145c7ed52f2STeresa Johnson   /// and, if applicable, linked with an existing destination global.
146c7ed52f2STeresa Johnson   /// Handles visibility change required for promoted locals.
147c7ed52f2STeresa Johnson   void setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
148c7ed52f2STeresa Johnson                      const GlobalValue *DGV = nullptr);
149c7ed52f2STeresa Johnson 
150d57f9f0cSRafael Espindola public:
151caabe228SRafael Espindola   ModuleLinker(IRMover &Mover, Module &SrcM, unsigned Flags,
152d57f9f0cSRafael Espindola                const FunctionInfoIndex *Index = nullptr,
153d57f9f0cSRafael Espindola                DenseSet<const GlobalValue *> *FunctionsToImport = nullptr)
154caabe228SRafael Espindola       : Mover(Mover), SrcM(SrcM), Flags(Flags), ImportIndex(Index),
155d57f9f0cSRafael Espindola         ImportFunction(FunctionsToImport) {
156d57f9f0cSRafael Espindola     assert((ImportIndex || !ImportFunction) &&
157d57f9f0cSRafael Espindola            "Expect a FunctionInfoIndex when importing");
158d57f9f0cSRafael Espindola     // If we have a FunctionInfoIndex but no function to import,
159d57f9f0cSRafael Espindola     // then this is the primary module being compiled in a ThinLTO
160d57f9f0cSRafael Espindola     // backend compilation, and we need to see if it has functions that
161d57f9f0cSRafael Espindola     // may be exported to another backend compilation.
162d57f9f0cSRafael Espindola     if (ImportIndex && !ImportFunction)
163d57f9f0cSRafael Espindola       HasExportedFunctions = ImportIndex->hasExportedFunctions(SrcM);
164d57f9f0cSRafael Espindola   }
165d57f9f0cSRafael Espindola 
166d57f9f0cSRafael Espindola   bool run();
167eee6f995SChris Lattner };
168f00654e3SAlexander Kornienko }
169d48b7783SBill Wendling 
17018c89411SRafael Espindola /// The LLVM SymbolTable class autorenames globals that conflict in the symbol
17118c89411SRafael Espindola /// table. This is good for all clients except for us. Go through the trouble
17218c89411SRafael Espindola /// to force this back.
173b1ed91f3SChris Lattner static void forceRenaming(GlobalValue *GV, StringRef Name) {
174b1ed91f3SChris Lattner   // If the global doesn't force its name or if it already has the right name,
175b1ed91f3SChris Lattner   // there is nothing for us to do.
176c7ed52f2STeresa Johnson   // Note that any required local to global promotion should already be done,
177c7ed52f2STeresa Johnson   // so promoted locals will not skip this handling as their linkage is no
178c7ed52f2STeresa Johnson   // longer local.
179b1ed91f3SChris Lattner   if (GV->hasLocalLinkage() || GV->getName() == Name)
180b1ed91f3SChris Lattner     return;
181b1ed91f3SChris Lattner 
182b1ed91f3SChris Lattner   Module *M = GV->getParent();
183361e513dSReid Spencer 
184361e513dSReid Spencer   // If there is a conflict, rename the conflict.
185b1ed91f3SChris Lattner   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
1862a8d2e0eSChris Lattner     GV->takeName(ConflictGV);
187361e513dSReid Spencer     ConflictGV->setName(Name); // This will cause ConflictGV to get renamed
188b1ed91f3SChris Lattner     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
1892a8d2e0eSChris Lattner   } else {
1902a8d2e0eSChris Lattner     GV->setName(Name); // Force the name back
1913aaaa0b2SReid Spencer   }
1923aaaa0b2SReid Spencer }
1933aaaa0b2SReid Spencer 
19418c89411SRafael Espindola /// copy additional attributes (those not needed to construct a GlobalValue)
19518c89411SRafael Espindola /// from the SrcGV to the DestGV.
196c7ed52f2STeresa Johnson void ModuleLinker::copyGVAttributes(GlobalValue *NewGV,
197c7ed52f2STeresa Johnson                                     const GlobalValue *SrcGV) {
198c7ed52f2STeresa Johnson   NewGV->copyAttributesFrom(SrcGV);
199c7ed52f2STeresa Johnson   forceRenaming(NewGV, getName(SrcGV));
200361e513dSReid Spencer }
201361e513dSReid Spencer 
202c7ed52f2STeresa Johnson bool ModuleLinker::doImportAsDefinition(const GlobalValue *SGV) {
203c7ed52f2STeresa Johnson   if (!isPerformingImport())
204c7ed52f2STeresa Johnson     return false;
2053cd8161cSTeresa Johnson   auto *GA = dyn_cast<GlobalAlias>(SGV);
2063cd8161cSTeresa Johnson   if (GA) {
2073cd8161cSTeresa Johnson     if (GA->hasWeakAnyLinkage())
2083cd8161cSTeresa Johnson       return false;
20989345771SRafael Espindola     const GlobalObject *GO = GA->getBaseObject();
21089345771SRafael Espindola     if (!GO->hasLinkOnceODRLinkage())
21189345771SRafael Espindola       return false;
21289345771SRafael Espindola     return doImportAsDefinition(GO);
2133cd8161cSTeresa Johnson   }
214dfbebc37STeresa Johnson   // Always import GlobalVariable definitions, except for the special
215dfbebc37STeresa Johnson   // case of WeakAny which are imported as ExternalWeak declarations
216dfbebc37STeresa Johnson   // (see comments in ModuleLinker::getLinkage). The linkage changes
217c7ed52f2STeresa Johnson   // described in ModuleLinker::getLinkage ensure the correct behavior (e.g.
218c7ed52f2STeresa Johnson   // global variables with external linkage are transformed to
2193cd8161cSTeresa Johnson   // available_externally definitions, which are ultimately turned into
2203cd8161cSTeresa Johnson   // declarations after the EliminateAvailableExternally pass).
22166059c9fSCraig Topper   if (isa<GlobalVariable>(SGV) && !SGV->isDeclaration() &&
2223cd8161cSTeresa Johnson       !SGV->hasWeakAnyLinkage())
223c7ed52f2STeresa Johnson     return true;
224c7ed52f2STeresa Johnson   // Only import the function requested for importing.
225c7ed52f2STeresa Johnson   auto *SF = dyn_cast<Function>(SGV);
226ffe2e4aaSMehdi Amini   if (SF && ImportFunction->count(SF))
227c7ed52f2STeresa Johnson     return true;
228c7ed52f2STeresa Johnson   // Otherwise no.
229c7ed52f2STeresa Johnson   return false;
230c7ed52f2STeresa Johnson }
231c7ed52f2STeresa Johnson 
232c7ed52f2STeresa Johnson bool ModuleLinker::doPromoteLocalToGlobal(const GlobalValue *SGV) {
233c7ed52f2STeresa Johnson   assert(SGV->hasLocalLinkage());
234c7ed52f2STeresa Johnson   // Both the imported references and the original local variable must
235c7ed52f2STeresa Johnson   // be promoted.
236c7ed52f2STeresa Johnson   if (!isPerformingImport() && !isModuleExporting())
237c7ed52f2STeresa Johnson     return false;
238c7ed52f2STeresa Johnson 
239c7ed52f2STeresa Johnson   // Local const variables never need to be promoted unless they are address
240c7ed52f2STeresa Johnson   // taken. The imported uses can simply use the clone created in this module.
241c7ed52f2STeresa Johnson   // For now we are conservative in determining which variables are not
242c7ed52f2STeresa Johnson   // address taken by checking the unnamed addr flag. To be more aggressive,
243c7ed52f2STeresa Johnson   // the address taken information must be checked earlier during parsing
244c7ed52f2STeresa Johnson   // of the module and recorded in the function index for use when importing
245c7ed52f2STeresa Johnson   // from that module.
246c7ed52f2STeresa Johnson   auto *GVar = dyn_cast<GlobalVariable>(SGV);
247c7ed52f2STeresa Johnson   if (GVar && GVar->isConstant() && GVar->hasUnnamedAddr())
248c7ed52f2STeresa Johnson     return false;
249c7ed52f2STeresa Johnson 
250c7ed52f2STeresa Johnson   // Eventually we only need to promote functions in the exporting module that
251c7ed52f2STeresa Johnson   // are referenced by a potentially exported function (i.e. one that is in the
252c7ed52f2STeresa Johnson   // function index).
253c7ed52f2STeresa Johnson   return true;
254c7ed52f2STeresa Johnson }
255c7ed52f2STeresa Johnson 
256c7ed52f2STeresa Johnson std::string ModuleLinker::getName(const GlobalValue *SGV) {
257c7ed52f2STeresa Johnson   // For locals that must be promoted to global scope, ensure that
258c7ed52f2STeresa Johnson   // the promoted name uniquely identifies the copy in the original module,
259c7ed52f2STeresa Johnson   // using the ID assigned during combined index creation. When importing,
260c7ed52f2STeresa Johnson   // we rename all locals (not just those that are promoted) in order to
261c7ed52f2STeresa Johnson   // avoid naming conflicts between locals imported from different modules.
262c7ed52f2STeresa Johnson   if (SGV->hasLocalLinkage() &&
263c7ed52f2STeresa Johnson       (doPromoteLocalToGlobal(SGV) || isPerformingImport()))
264c7ed52f2STeresa Johnson     return FunctionInfoIndex::getGlobalNameForLocal(
265c7ed52f2STeresa Johnson         SGV->getName(),
266c7ed52f2STeresa Johnson         ImportIndex->getModuleId(SGV->getParent()->getModuleIdentifier()));
267c7ed52f2STeresa Johnson   return SGV->getName();
268c7ed52f2STeresa Johnson }
269c7ed52f2STeresa Johnson 
270c7ed52f2STeresa Johnson GlobalValue::LinkageTypes ModuleLinker::getLinkage(const GlobalValue *SGV) {
271c7ed52f2STeresa Johnson   // Any local variable that is referenced by an exported function needs
272c7ed52f2STeresa Johnson   // to be promoted to global scope. Since we don't currently know which
273c7ed52f2STeresa Johnson   // functions reference which local variables/functions, we must treat
274c7ed52f2STeresa Johnson   // all as potentially exported if this module is exporting anything.
275c7ed52f2STeresa Johnson   if (isModuleExporting()) {
276c7ed52f2STeresa Johnson     if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
277c7ed52f2STeresa Johnson       return GlobalValue::ExternalLinkage;
278c7ed52f2STeresa Johnson     return SGV->getLinkage();
279c7ed52f2STeresa Johnson   }
280c7ed52f2STeresa Johnson 
281c7ed52f2STeresa Johnson   // Otherwise, if we aren't importing, no linkage change is needed.
282c7ed52f2STeresa Johnson   if (!isPerformingImport())
283c7ed52f2STeresa Johnson     return SGV->getLinkage();
284c7ed52f2STeresa Johnson 
285c7ed52f2STeresa Johnson   switch (SGV->getLinkage()) {
286c7ed52f2STeresa Johnson   case GlobalValue::ExternalLinkage:
287c7ed52f2STeresa Johnson     // External defnitions are converted to available_externally
288c7ed52f2STeresa Johnson     // definitions upon import, so that they are available for inlining
289c7ed52f2STeresa Johnson     // and/or optimization, but are turned into declarations later
290c7ed52f2STeresa Johnson     // during the EliminateAvailableExternally pass.
2913cd8161cSTeresa Johnson     if (doImportAsDefinition(SGV) && !dyn_cast<GlobalAlias>(SGV))
292c7ed52f2STeresa Johnson       return GlobalValue::AvailableExternallyLinkage;
293c7ed52f2STeresa Johnson     // An imported external declaration stays external.
294c7ed52f2STeresa Johnson     return SGV->getLinkage();
295c7ed52f2STeresa Johnson 
296c7ed52f2STeresa Johnson   case GlobalValue::AvailableExternallyLinkage:
297c7ed52f2STeresa Johnson     // An imported available_externally definition converts
298c7ed52f2STeresa Johnson     // to external if imported as a declaration.
299c7ed52f2STeresa Johnson     if (!doImportAsDefinition(SGV))
300c7ed52f2STeresa Johnson       return GlobalValue::ExternalLinkage;
301c7ed52f2STeresa Johnson     // An imported available_externally declaration stays that way.
302c7ed52f2STeresa Johnson     return SGV->getLinkage();
303c7ed52f2STeresa Johnson 
304c7ed52f2STeresa Johnson   case GlobalValue::LinkOnceAnyLinkage:
305c7ed52f2STeresa Johnson   case GlobalValue::LinkOnceODRLinkage:
306c7ed52f2STeresa Johnson     // These both stay the same when importing the definition.
307c7ed52f2STeresa Johnson     // The ThinLTO pass will eventually force-import their definitions.
308c7ed52f2STeresa Johnson     return SGV->getLinkage();
309c7ed52f2STeresa Johnson 
310c7ed52f2STeresa Johnson   case GlobalValue::WeakAnyLinkage:
311c7ed52f2STeresa Johnson     // Can't import weak_any definitions correctly, or we might change the
312c7ed52f2STeresa Johnson     // program semantics, since the linker will pick the first weak_any
313c7ed52f2STeresa Johnson     // definition and importing would change the order they are seen by the
314c7ed52f2STeresa Johnson     // linker. The module linking caller needs to enforce this.
315c7ed52f2STeresa Johnson     assert(!doImportAsDefinition(SGV));
316c7ed52f2STeresa Johnson     // If imported as a declaration, it becomes external_weak.
317c7ed52f2STeresa Johnson     return GlobalValue::ExternalWeakLinkage;
318c7ed52f2STeresa Johnson 
319c7ed52f2STeresa Johnson   case GlobalValue::WeakODRLinkage:
320c7ed52f2STeresa Johnson     // For weak_odr linkage, there is a guarantee that all copies will be
321c7ed52f2STeresa Johnson     // equivalent, so the issue described above for weak_any does not exist,
322c7ed52f2STeresa Johnson     // and the definition can be imported. It can be treated similarly
323c7ed52f2STeresa Johnson     // to an imported externally visible global value.
3243cd8161cSTeresa Johnson     if (doImportAsDefinition(SGV) && !dyn_cast<GlobalAlias>(SGV))
325c7ed52f2STeresa Johnson       return GlobalValue::AvailableExternallyLinkage;
326c7ed52f2STeresa Johnson     else
327c7ed52f2STeresa Johnson       return GlobalValue::ExternalLinkage;
328c7ed52f2STeresa Johnson 
329c7ed52f2STeresa Johnson   case GlobalValue::AppendingLinkage:
330c7ed52f2STeresa Johnson     // It would be incorrect to import an appending linkage variable,
331c7ed52f2STeresa Johnson     // since it would cause global constructors/destructors to be
332c7ed52f2STeresa Johnson     // executed multiple times. This should have already been handled
3331e20a652STeresa Johnson     // by linkIfNeeded, and we will assert in shouldLinkFromSource
3341e20a652STeresa Johnson     // if we try to import, so we simply return AppendingLinkage here
3351e20a652STeresa Johnson     // as this helper is called more widely in getLinkedToGlobal.
3361e20a652STeresa Johnson     return GlobalValue::AppendingLinkage;
337c7ed52f2STeresa Johnson 
338c7ed52f2STeresa Johnson   case GlobalValue::InternalLinkage:
339c7ed52f2STeresa Johnson   case GlobalValue::PrivateLinkage:
340c7ed52f2STeresa Johnson     // If we are promoting the local to global scope, it is handled
341c7ed52f2STeresa Johnson     // similarly to a normal externally visible global.
342c7ed52f2STeresa Johnson     if (doPromoteLocalToGlobal(SGV)) {
3433cd8161cSTeresa Johnson       if (doImportAsDefinition(SGV) && !dyn_cast<GlobalAlias>(SGV))
344c7ed52f2STeresa Johnson         return GlobalValue::AvailableExternallyLinkage;
345c7ed52f2STeresa Johnson       else
346c7ed52f2STeresa Johnson         return GlobalValue::ExternalLinkage;
347c7ed52f2STeresa Johnson     }
348c7ed52f2STeresa Johnson     // A non-promoted imported local definition stays local.
349c7ed52f2STeresa Johnson     // The ThinLTO pass will eventually force-import their definitions.
350c7ed52f2STeresa Johnson     return SGV->getLinkage();
351c7ed52f2STeresa Johnson 
352c7ed52f2STeresa Johnson   case GlobalValue::ExternalWeakLinkage:
353c7ed52f2STeresa Johnson     // External weak doesn't apply to definitions, must be a declaration.
354c7ed52f2STeresa Johnson     assert(!doImportAsDefinition(SGV));
355c7ed52f2STeresa Johnson     // Linkage stays external_weak.
356c7ed52f2STeresa Johnson     return SGV->getLinkage();
357c7ed52f2STeresa Johnson 
358c7ed52f2STeresa Johnson   case GlobalValue::CommonLinkage:
359c7ed52f2STeresa Johnson     // Linkage stays common on definitions.
360c7ed52f2STeresa Johnson     // The ThinLTO pass will eventually force-import their definitions.
361c7ed52f2STeresa Johnson     return SGV->getLinkage();
362c7ed52f2STeresa Johnson   }
363c7ed52f2STeresa Johnson 
364c7ed52f2STeresa Johnson   llvm_unreachable("unknown linkage type");
365c7ed52f2STeresa Johnson }
366c7ed52f2STeresa Johnson 
367eb5e0a77SRafael Espindola static GlobalValue::VisibilityTypes
368eb5e0a77SRafael Espindola getMinVisibility(GlobalValue::VisibilityTypes A,
369eb5e0a77SRafael Espindola                  GlobalValue::VisibilityTypes B) {
370eb5e0a77SRafael Espindola   if (A == GlobalValue::HiddenVisibility || B == GlobalValue::HiddenVisibility)
371eb5e0a77SRafael Espindola     return GlobalValue::HiddenVisibility;
372eb5e0a77SRafael Espindola   if (A == GlobalValue::ProtectedVisibility ||
373eb5e0a77SRafael Espindola       B == GlobalValue::ProtectedVisibility)
374eb5e0a77SRafael Espindola     return GlobalValue::ProtectedVisibility;
375eb5e0a77SRafael Espindola   return GlobalValue::DefaultVisibility;
376eb5e0a77SRafael Espindola }
377eb5e0a77SRafael Espindola 
378c7ed52f2STeresa Johnson void ModuleLinker::setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
379c7ed52f2STeresa Johnson                                  const GlobalValue *DGV) {
380c7ed52f2STeresa Johnson   GlobalValue::VisibilityTypes Visibility = SGV->getVisibility();
381c7ed52f2STeresa Johnson   if (DGV)
382eb5e0a77SRafael Espindola     Visibility = getMinVisibility(DGV->getVisibility(), Visibility);
383c7ed52f2STeresa Johnson   // For promoted locals, mark them hidden so that they can later be
384c7ed52f2STeresa Johnson   // stripped from the symbol table to reduce bloat.
385c7ed52f2STeresa Johnson   if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
386c7ed52f2STeresa Johnson     Visibility = GlobalValue::HiddenVisibility;
387c7ed52f2STeresa Johnson   NewGV->setVisibility(Visibility);
388c7ed52f2STeresa Johnson }
389c7ed52f2STeresa Johnson 
3900e309fe8SRafael Espindola bool ModuleLinker::getComdatLeader(Module &M, StringRef ComdatName,
391dad0a645SDavid Majnemer                                    const GlobalVariable *&GVar) {
3920e309fe8SRafael Espindola   const GlobalValue *GVal = M.getNamedValue(ComdatName);
393dad0a645SDavid Majnemer   if (const auto *GA = dyn_cast_or_null<GlobalAlias>(GVal)) {
394dad0a645SDavid Majnemer     GVal = GA->getBaseObject();
395dad0a645SDavid Majnemer     if (!GVal)
396dad0a645SDavid Majnemer       // We cannot resolve the size of the aliasee yet.
397dad0a645SDavid Majnemer       return emitError("Linking COMDATs named '" + ComdatName +
398dad0a645SDavid Majnemer                        "': COMDAT key involves incomputable alias size.");
399dad0a645SDavid Majnemer   }
400dad0a645SDavid Majnemer 
401dad0a645SDavid Majnemer   GVar = dyn_cast_or_null<GlobalVariable>(GVal);
402dad0a645SDavid Majnemer   if (!GVar)
403dad0a645SDavid Majnemer     return emitError(
404dad0a645SDavid Majnemer         "Linking COMDATs named '" + ComdatName +
405dad0a645SDavid Majnemer         "': GlobalVariable required for data dependent selection!");
406dad0a645SDavid Majnemer 
407dad0a645SDavid Majnemer   return false;
408dad0a645SDavid Majnemer }
409dad0a645SDavid Majnemer 
410dad0a645SDavid Majnemer bool ModuleLinker::computeResultingSelectionKind(StringRef ComdatName,
411dad0a645SDavid Majnemer                                                  Comdat::SelectionKind Src,
412dad0a645SDavid Majnemer                                                  Comdat::SelectionKind Dst,
413dad0a645SDavid Majnemer                                                  Comdat::SelectionKind &Result,
414dad0a645SDavid Majnemer                                                  bool &LinkFromSrc) {
415caabe228SRafael Espindola   Module &DstM = Mover.getModule();
416dad0a645SDavid Majnemer   // The ability to mix Comdat::SelectionKind::Any with
417dad0a645SDavid Majnemer   // Comdat::SelectionKind::Largest is a behavior that comes from COFF.
418dad0a645SDavid Majnemer   bool DstAnyOrLargest = Dst == Comdat::SelectionKind::Any ||
419dad0a645SDavid Majnemer                          Dst == Comdat::SelectionKind::Largest;
420dad0a645SDavid Majnemer   bool SrcAnyOrLargest = Src == Comdat::SelectionKind::Any ||
421dad0a645SDavid Majnemer                          Src == Comdat::SelectionKind::Largest;
422dad0a645SDavid Majnemer   if (DstAnyOrLargest && SrcAnyOrLargest) {
423dad0a645SDavid Majnemer     if (Dst == Comdat::SelectionKind::Largest ||
424dad0a645SDavid Majnemer         Src == Comdat::SelectionKind::Largest)
425dad0a645SDavid Majnemer       Result = Comdat::SelectionKind::Largest;
426dad0a645SDavid Majnemer     else
427dad0a645SDavid Majnemer       Result = Comdat::SelectionKind::Any;
428dad0a645SDavid Majnemer   } else if (Src == Dst) {
429dad0a645SDavid Majnemer     Result = Dst;
430dad0a645SDavid Majnemer   } else {
431dad0a645SDavid Majnemer     return emitError("Linking COMDATs named '" + ComdatName +
432dad0a645SDavid Majnemer                      "': invalid selection kinds!");
433dad0a645SDavid Majnemer   }
434dad0a645SDavid Majnemer 
435dad0a645SDavid Majnemer   switch (Result) {
436dad0a645SDavid Majnemer   case Comdat::SelectionKind::Any:
437dad0a645SDavid Majnemer     // Go with Dst.
438dad0a645SDavid Majnemer     LinkFromSrc = false;
439dad0a645SDavid Majnemer     break;
440dad0a645SDavid Majnemer   case Comdat::SelectionKind::NoDuplicates:
441dad0a645SDavid Majnemer     return emitError("Linking COMDATs named '" + ComdatName +
442dad0a645SDavid Majnemer                      "': noduplicates has been violated!");
443dad0a645SDavid Majnemer   case Comdat::SelectionKind::ExactMatch:
444dad0a645SDavid Majnemer   case Comdat::SelectionKind::Largest:
445dad0a645SDavid Majnemer   case Comdat::SelectionKind::SameSize: {
446dad0a645SDavid Majnemer     const GlobalVariable *DstGV;
447dad0a645SDavid Majnemer     const GlobalVariable *SrcGV;
448dad0a645SDavid Majnemer     if (getComdatLeader(DstM, ComdatName, DstGV) ||
449dad0a645SDavid Majnemer         getComdatLeader(SrcM, ComdatName, SrcGV))
450dad0a645SDavid Majnemer       return true;
451dad0a645SDavid Majnemer 
4520e309fe8SRafael Espindola     const DataLayout &DstDL = DstM.getDataLayout();
4530e309fe8SRafael Espindola     const DataLayout &SrcDL = SrcM.getDataLayout();
454dad0a645SDavid Majnemer     uint64_t DstSize =
45546a43556SMehdi Amini         DstDL.getTypeAllocSize(DstGV->getType()->getPointerElementType());
456dad0a645SDavid Majnemer     uint64_t SrcSize =
45746a43556SMehdi Amini         SrcDL.getTypeAllocSize(SrcGV->getType()->getPointerElementType());
458dad0a645SDavid Majnemer     if (Result == Comdat::SelectionKind::ExactMatch) {
459dad0a645SDavid Majnemer       if (SrcGV->getInitializer() != DstGV->getInitializer())
460dad0a645SDavid Majnemer         return emitError("Linking COMDATs named '" + ComdatName +
461dad0a645SDavid Majnemer                          "': ExactMatch violated!");
462dad0a645SDavid Majnemer       LinkFromSrc = false;
463dad0a645SDavid Majnemer     } else if (Result == Comdat::SelectionKind::Largest) {
464dad0a645SDavid Majnemer       LinkFromSrc = SrcSize > DstSize;
465dad0a645SDavid Majnemer     } else if (Result == Comdat::SelectionKind::SameSize) {
466dad0a645SDavid Majnemer       if (SrcSize != DstSize)
467dad0a645SDavid Majnemer         return emitError("Linking COMDATs named '" + ComdatName +
468dad0a645SDavid Majnemer                          "': SameSize violated!");
469dad0a645SDavid Majnemer       LinkFromSrc = false;
470dad0a645SDavid Majnemer     } else {
471dad0a645SDavid Majnemer       llvm_unreachable("unknown selection kind");
472dad0a645SDavid Majnemer     }
473dad0a645SDavid Majnemer     break;
474dad0a645SDavid Majnemer   }
475dad0a645SDavid Majnemer   }
476dad0a645SDavid Majnemer 
477dad0a645SDavid Majnemer   return false;
478dad0a645SDavid Majnemer }
479dad0a645SDavid Majnemer 
480dad0a645SDavid Majnemer bool ModuleLinker::getComdatResult(const Comdat *SrcC,
481dad0a645SDavid Majnemer                                    Comdat::SelectionKind &Result,
482dad0a645SDavid Majnemer                                    bool &LinkFromSrc) {
483caabe228SRafael Espindola   Module &DstM = Mover.getModule();
484b16196a3SRafael Espindola   Comdat::SelectionKind SSK = SrcC->getSelectionKind();
485dad0a645SDavid Majnemer   StringRef ComdatName = SrcC->getName();
4860e309fe8SRafael Espindola   Module::ComdatSymTabType &ComdatSymTab = DstM.getComdatSymbolTable();
487dad0a645SDavid Majnemer   Module::ComdatSymTabType::iterator DstCI = ComdatSymTab.find(ComdatName);
4882ef3f299SRafael Espindola 
489b16196a3SRafael Espindola   if (DstCI == ComdatSymTab.end()) {
490b16196a3SRafael Espindola     // Use the comdat if it is only available in one of the modules.
491b16196a3SRafael Espindola     LinkFromSrc = true;
492b16196a3SRafael Espindola     Result = SSK;
4932ef3f299SRafael Espindola     return false;
494b16196a3SRafael Espindola   }
4952ef3f299SRafael Espindola 
496dad0a645SDavid Majnemer   const Comdat *DstC = &DstCI->second;
497dad0a645SDavid Majnemer   Comdat::SelectionKind DSK = DstC->getSelectionKind();
4982ef3f299SRafael Espindola   return computeResultingSelectionKind(ComdatName, SSK, DSK, Result,
4992ef3f299SRafael Espindola                                        LinkFromSrc);
500dad0a645SDavid Majnemer }
501f6f121e2SJames Molloy 
502d12b4a33SRafael Espindola bool ModuleLinker::shouldLinkFromSource(bool &LinkFromSrc,
503d12b4a33SRafael Espindola                                         const GlobalValue &Dest,
504dbb0bd1aSRafael Espindola                                         const GlobalValue &Src) {
505e868123dSDuncan P. N. Exon Smith   // Should we unconditionally use the Src?
506020d4fb1SArtem Belevich   if (shouldOverrideFromSrc()) {
507e868123dSDuncan P. N. Exon Smith     LinkFromSrc = true;
508e868123dSDuncan P. N. Exon Smith     return false;
509e868123dSDuncan P. N. Exon Smith   }
510e868123dSDuncan P. N. Exon Smith 
511778fcc77SRafael Espindola   // We always have to add Src if it has appending linkage.
512778fcc77SRafael Espindola   if (Src.hasAppendingLinkage()) {
5131e20a652STeresa Johnson     // Should have prevented importing for appending linkage in linkIfNeeded.
514c7ed52f2STeresa Johnson     assert(!isPerformingImport());
515778fcc77SRafael Espindola     LinkFromSrc = true;
516778fcc77SRafael Espindola     return false;
517778fcc77SRafael Espindola   }
518778fcc77SRafael Espindola 
519d4bcefc7SRafael Espindola   bool SrcIsDeclaration = Src.isDeclarationForLinker();
520d4bcefc7SRafael Espindola   bool DestIsDeclaration = Dest.isDeclarationForLinker();
521dbb0bd1aSRafael Espindola 
522c7ed52f2STeresa Johnson   if (isPerformingImport()) {
523c7ed52f2STeresa Johnson     if (isa<Function>(&Src)) {
524c7ed52f2STeresa Johnson       // For functions, LinkFromSrc iff this is the function requested
525c7ed52f2STeresa Johnson       // for importing. For variables, decide below normally.
526ffe2e4aaSMehdi Amini       LinkFromSrc = ImportFunction->count(&Src);
527c7ed52f2STeresa Johnson       return false;
528c7ed52f2STeresa Johnson     }
529c7ed52f2STeresa Johnson 
530c7ed52f2STeresa Johnson     // Check if this is an alias with an already existing definition
531c7ed52f2STeresa Johnson     // in Dest, which must have come from a prior importing pass from
532c7ed52f2STeresa Johnson     // the same Src module. Unlike imported function and variable
533c7ed52f2STeresa Johnson     // definitions, which are imported as available_externally and are
534c7ed52f2STeresa Johnson     // not definitions for the linker, that is not a valid linkage for
535c7ed52f2STeresa Johnson     // imported aliases which must be definitions. Simply use the existing
536c7ed52f2STeresa Johnson     // Dest copy.
537c7ed52f2STeresa Johnson     if (isa<GlobalAlias>(&Src) && !DestIsDeclaration) {
538c7ed52f2STeresa Johnson       assert(isa<GlobalAlias>(&Dest));
539c7ed52f2STeresa Johnson       LinkFromSrc = false;
540c7ed52f2STeresa Johnson       return false;
541c7ed52f2STeresa Johnson     }
542c7ed52f2STeresa Johnson   }
543c7ed52f2STeresa Johnson 
544dbb0bd1aSRafael Espindola   if (SrcIsDeclaration) {
545dbb0bd1aSRafael Espindola     // If Src is external or if both Src & Dest are external..  Just link the
546dbb0bd1aSRafael Espindola     // external globals, we aren't adding anything.
547d12b4a33SRafael Espindola     if (Src.hasDLLImportStorageClass()) {
548dbb0bd1aSRafael Espindola       // If one of GVs is marked as DLLImport, result should be dllimport'ed.
549d12b4a33SRafael Espindola       LinkFromSrc = DestIsDeclaration;
550d12b4a33SRafael Espindola       return false;
551d12b4a33SRafael Espindola     }
552dbb0bd1aSRafael Espindola     // If the Dest is weak, use the source linkage.
553ed11bd28SRafael Espindola     if (Dest.hasExternalWeakLinkage()) {
554ed11bd28SRafael Espindola       LinkFromSrc = true;
555ed11bd28SRafael Espindola       return false;
556ed11bd28SRafael Espindola     }
557ed11bd28SRafael Espindola     // Link an available_externally over a declaration.
558ed11bd28SRafael Espindola     LinkFromSrc = !Src.isDeclaration() && Dest.isDeclaration();
559d12b4a33SRafael Espindola     return false;
560dbb0bd1aSRafael Espindola   }
561dbb0bd1aSRafael Espindola 
562d12b4a33SRafael Espindola   if (DestIsDeclaration) {
563dbb0bd1aSRafael Espindola     // If Dest is external but Src is not:
564d12b4a33SRafael Espindola     LinkFromSrc = true;
565d12b4a33SRafael Espindola     return false;
566d12b4a33SRafael Espindola   }
567dbb0bd1aSRafael Espindola 
5680910605aSRafael Espindola   if (Src.hasCommonLinkage()) {
569d12b4a33SRafael Espindola     if (Dest.hasLinkOnceLinkage() || Dest.hasWeakLinkage()) {
570d12b4a33SRafael Espindola       LinkFromSrc = true;
5710910605aSRafael Espindola       return false;
572d12b4a33SRafael Espindola     }
573d12b4a33SRafael Espindola 
574d12b4a33SRafael Espindola     if (!Dest.hasCommonLinkage()) {
575d12b4a33SRafael Espindola       LinkFromSrc = false;
576d12b4a33SRafael Espindola       return false;
577d12b4a33SRafael Espindola     }
5780910605aSRafael Espindola 
579a28d91d8SMehdi Amini     const DataLayout &DL = Dest.getParent()->getDataLayout();
5800910605aSRafael Espindola     uint64_t DestSize = DL.getTypeAllocSize(Dest.getType()->getElementType());
5810910605aSRafael Espindola     uint64_t SrcSize = DL.getTypeAllocSize(Src.getType()->getElementType());
582d12b4a33SRafael Espindola     LinkFromSrc = SrcSize > DestSize;
583d12b4a33SRafael Espindola     return false;
5840910605aSRafael Espindola   }
5850910605aSRafael Espindola 
586dbb0bd1aSRafael Espindola   if (Src.isWeakForLinker()) {
587dbb0bd1aSRafael Espindola     assert(!Dest.hasExternalWeakLinkage());
588dbb0bd1aSRafael Espindola     assert(!Dest.hasAvailableExternallyLinkage());
5890910605aSRafael Espindola 
590d12b4a33SRafael Espindola     if (Dest.hasLinkOnceLinkage() && Src.hasWeakLinkage()) {
591d12b4a33SRafael Espindola       LinkFromSrc = true;
592d12b4a33SRafael Espindola       return false;
593d12b4a33SRafael Espindola     }
594dbb0bd1aSRafael Espindola 
595d12b4a33SRafael Espindola     LinkFromSrc = false;
5960910605aSRafael Espindola     return false;
597dbb0bd1aSRafael Espindola   }
598dbb0bd1aSRafael Espindola 
599dbb0bd1aSRafael Espindola   if (Dest.isWeakForLinker()) {
600dbb0bd1aSRafael Espindola     assert(Src.hasExternalLinkage());
601d12b4a33SRafael Espindola     LinkFromSrc = true;
602d12b4a33SRafael Espindola     return false;
603dbb0bd1aSRafael Espindola   }
604dbb0bd1aSRafael Espindola 
605dbb0bd1aSRafael Espindola   assert(!Src.hasExternalWeakLinkage());
606dbb0bd1aSRafael Espindola   assert(!Dest.hasExternalWeakLinkage());
607dbb0bd1aSRafael Espindola   assert(Dest.hasExternalLinkage() && Src.hasExternalLinkage() &&
608dbb0bd1aSRafael Espindola          "Unexpected linkage type!");
609dbb0bd1aSRafael Espindola   return emitError("Linking globals named '" + Src.getName() +
610dbb0bd1aSRafael Espindola                    "': symbol multiply defined!");
611dbb0bd1aSRafael Espindola }
612dbb0bd1aSRafael Espindola 
613baa3bf8fSRafael Espindola bool ModuleLinker::linkIfNeeded(GlobalValue &GV) {
614baa3bf8fSRafael Espindola   GlobalValue *DGV = getLinkedToGlobal(&GV);
615baa3bf8fSRafael Espindola 
616baa3bf8fSRafael Espindola   if (shouldLinkOnlyNeeded() && !(DGV && DGV->isDeclaration()))
617baa3bf8fSRafael Espindola     return false;
618baa3bf8fSRafael Espindola 
6194b5ec263SRafael Espindola   if (DGV && !GV.hasLocalLinkage() && !GV.hasAppendingLinkage()) {
6204b5ec263SRafael Espindola     auto *DGVar = dyn_cast<GlobalVariable>(DGV);
6214b5ec263SRafael Espindola     auto *SGVar = dyn_cast<GlobalVariable>(&GV);
6224b5ec263SRafael Espindola     if (DGVar && SGVar) {
6234b5ec263SRafael Espindola       if (DGVar->isDeclaration() && SGVar->isDeclaration() &&
6244b5ec263SRafael Espindola           (!DGVar->isConstant() || !SGVar->isConstant())) {
6254b5ec263SRafael Espindola         DGVar->setConstant(false);
6264b5ec263SRafael Espindola         SGVar->setConstant(false);
6274b5ec263SRafael Espindola       }
6284b5ec263SRafael Espindola       if (DGVar->hasCommonLinkage() && SGVar->hasCommonLinkage()) {
6294b5ec263SRafael Espindola         unsigned Align = std::max(DGVar->getAlignment(), SGVar->getAlignment());
6304b5ec263SRafael Espindola         SGVar->setAlignment(Align);
6314b5ec263SRafael Espindola         DGVar->setAlignment(Align);
6324b5ec263SRafael Espindola       }
6334b5ec263SRafael Espindola     }
6344b5ec263SRafael Espindola 
635baa3bf8fSRafael Espindola     GlobalValue::VisibilityTypes Visibility =
636baa3bf8fSRafael Espindola         getMinVisibility(DGV->getVisibility(), GV.getVisibility());
637baa3bf8fSRafael Espindola     DGV->setVisibility(Visibility);
638baa3bf8fSRafael Espindola     GV.setVisibility(Visibility);
6394b5ec263SRafael Espindola 
6404b5ec263SRafael Espindola     bool HasUnnamedAddr = GV.hasUnnamedAddr() && DGV->hasUnnamedAddr();
6414b5ec263SRafael Espindola     DGV->setUnnamedAddr(HasUnnamedAddr);
6424b5ec263SRafael Espindola     GV.setUnnamedAddr(HasUnnamedAddr);
643baa3bf8fSRafael Espindola   }
644baa3bf8fSRafael Espindola 
6454b5ec263SRafael Espindola   // Don't want to append to global_ctors list, for example, when we
6464b5ec263SRafael Espindola   // are importing for ThinLTO, otherwise the global ctors and dtors
6474b5ec263SRafael Espindola   // get executed multiple times for local variables (the latter causing
6484b5ec263SRafael Espindola   // double frees).
6494b5ec263SRafael Espindola   if (GV.hasAppendingLinkage() && isPerformingImport())
6504b5ec263SRafael Espindola     return false;
6514b5ec263SRafael Espindola 
6524b5ec263SRafael Espindola   if (isPerformingImport() && !doImportAsDefinition(&GV))
6534b5ec263SRafael Espindola     return false;
6544b5ec263SRafael Espindola 
6554b5ec263SRafael Espindola   if (!DGV && !shouldOverrideFromSrc() &&
6564b5ec263SRafael Espindola       (GV.hasLocalLinkage() || GV.hasLinkOnceLinkage() ||
6574b5ec263SRafael Espindola        GV.hasAvailableExternallyLinkage()))
6584b5ec263SRafael Espindola     return false;
6594b5ec263SRafael Espindola 
660bd03c503SRafael Espindola   if (GV.isDeclaration())
661bd03c503SRafael Espindola     return false;
662bd03c503SRafael Espindola 
663baa3bf8fSRafael Espindola   if (const Comdat *SC = GV.getComdat()) {
664baa3bf8fSRafael Espindola     bool LinkFromSrc;
665baa3bf8fSRafael Espindola     Comdat::SelectionKind SK;
666baa3bf8fSRafael Espindola     std::tie(SK, LinkFromSrc) = ComdatsChosen[SC];
6674b5ec263SRafael Espindola     if (LinkFromSrc)
6684b5ec263SRafael Espindola       ValuesToLink.insert(&GV);
669baa3bf8fSRafael Espindola     return false;
670baa3bf8fSRafael Espindola   }
671baa3bf8fSRafael Espindola 
6724b5ec263SRafael Espindola   bool LinkFromSrc = true;
6734b5ec263SRafael Espindola   if (DGV && shouldLinkFromSource(LinkFromSrc, *DGV, GV))
6744b5ec263SRafael Espindola     return true;
6754b5ec263SRafael Espindola   if (LinkFromSrc)
6764b5ec263SRafael Espindola     ValuesToLink.insert(&GV);
677baa3bf8fSRafael Espindola   return false;
678baa3bf8fSRafael Espindola }
679baa3bf8fSRafael Espindola 
680caabe228SRafael Espindola void ModuleLinker::addLazyFor(GlobalValue &GV, IRMover::ValueAdder Add) {
681caabe228SRafael Espindola   // Add these to the internalize list
682caabe228SRafael Espindola   if (!GV.hasLinkOnceLinkage())
683caabe228SRafael Espindola     return;
684caabe228SRafael Espindola 
685caabe228SRafael Espindola   if (shouldInternalizeLinkedSymbols())
686caabe228SRafael Espindola     Internalize.insert(GV.getName());
687caabe228SRafael Espindola   Add(GV);
688caabe228SRafael Espindola 
689caabe228SRafael Espindola   const Comdat *SC = GV.getComdat();
690caabe228SRafael Espindola   if (!SC)
691caabe228SRafael Espindola     return;
692caabe228SRafael Espindola   for (GlobalValue *GV2 : ComdatMembers[SC]) {
693caabe228SRafael Espindola     if (!GV2->hasLocalLinkage() && shouldInternalizeLinkedSymbols())
694caabe228SRafael Espindola       Internalize.insert(GV2->getName());
695caabe228SRafael Espindola     Add(*GV2);
696caabe228SRafael Espindola   }
697caabe228SRafael Espindola }
698caabe228SRafael Espindola 
699caabe228SRafael Espindola void ModuleLinker::processGlobalForThinLTO(GlobalValue &GV) {
700caabe228SRafael Espindola   if (GV.hasLocalLinkage() &&
701caabe228SRafael Espindola       (doPromoteLocalToGlobal(&GV) || isPerformingImport())) {
702caabe228SRafael Espindola     GV.setName(getName(&GV));
703caabe228SRafael Espindola     GV.setLinkage(getLinkage(&GV));
704caabe228SRafael Espindola     if (!GV.hasLocalLinkage())
705caabe228SRafael Espindola       GV.setVisibility(GlobalValue::HiddenVisibility);
706caabe228SRafael Espindola     if (isModuleExporting())
707caabe228SRafael Espindola       ValuesToLink.insert(&GV);
708caabe228SRafael Espindola     return;
709caabe228SRafael Espindola   }
710caabe228SRafael Espindola   GV.setLinkage(getLinkage(&GV));
711caabe228SRafael Espindola }
712caabe228SRafael Espindola 
713caabe228SRafael Espindola void ModuleLinker::processGlobalsForThinLTO() {
714caabe228SRafael Espindola   for (GlobalVariable &GV : SrcM.globals())
715caabe228SRafael Espindola     processGlobalForThinLTO(GV);
716caabe228SRafael Espindola   for (Function &SF : SrcM)
717caabe228SRafael Espindola     processGlobalForThinLTO(SF);
718caabe228SRafael Espindola   for (GlobalAlias &GA : SrcM.aliases())
719caabe228SRafael Espindola     processGlobalForThinLTO(GA);
720caabe228SRafael Espindola }
721caabe228SRafael Espindola 
722b1ed91f3SChris Lattner bool ModuleLinker::run() {
7230e309fe8SRafael Espindola   for (const auto &SMEC : SrcM.getComdatSymbolTable()) {
724dad0a645SDavid Majnemer     const Comdat &C = SMEC.getValue();
725dad0a645SDavid Majnemer     if (ComdatsChosen.count(&C))
726dad0a645SDavid Majnemer       continue;
727dad0a645SDavid Majnemer     Comdat::SelectionKind SK;
728dad0a645SDavid Majnemer     bool LinkFromSrc;
729dad0a645SDavid Majnemer     if (getComdatResult(&C, SK, LinkFromSrc))
730dad0a645SDavid Majnemer       return true;
731dad0a645SDavid Majnemer     ComdatsChosen[&C] = std::make_pair(SK, LinkFromSrc);
732dad0a645SDavid Majnemer   }
733dad0a645SDavid Majnemer 
7340e309fe8SRafael Espindola   for (GlobalVariable &GV : SrcM.globals())
735baa3bf8fSRafael Espindola     if (const Comdat *SC = GV.getComdat())
736baa3bf8fSRafael Espindola       ComdatMembers[SC].push_back(&GV);
737baa3bf8fSRafael Espindola 
7380e309fe8SRafael Espindola   for (Function &SF : SrcM)
739baa3bf8fSRafael Espindola     if (const Comdat *SC = SF.getComdat())
740baa3bf8fSRafael Espindola       ComdatMembers[SC].push_back(&SF);
741baa3bf8fSRafael Espindola 
7420e309fe8SRafael Espindola   for (GlobalAlias &GA : SrcM.aliases())
743baa3bf8fSRafael Espindola     if (const Comdat *SC = GA.getComdat())
744baa3bf8fSRafael Espindola       ComdatMembers[SC].push_back(&GA);
745baa3bf8fSRafael Espindola 
746b1ed91f3SChris Lattner   // Insert all of the globals in src into the DstM module... without linking
747b1ed91f3SChris Lattner   // initializers (which could refer to functions not yet mapped over).
7480e309fe8SRafael Espindola   for (GlobalVariable &GV : SrcM.globals())
749baa3bf8fSRafael Espindola     if (linkIfNeeded(GV))
750b1ed91f3SChris Lattner       return true;
751b1ed91f3SChris Lattner 
7520e309fe8SRafael Espindola   for (Function &SF : SrcM)
753baa3bf8fSRafael Espindola     if (linkIfNeeded(SF))
754b1ed91f3SChris Lattner       return true;
755b1ed91f3SChris Lattner 
7560e309fe8SRafael Espindola   for (GlobalAlias &GA : SrcM.aliases())
757baa3bf8fSRafael Espindola     if (linkIfNeeded(GA))
758b1ed91f3SChris Lattner       return true;
759b1ed91f3SChris Lattner 
760caabe228SRafael Espindola   processGlobalsForThinLTO();
761caabe228SRafael Espindola 
762caabe228SRafael Espindola   for (unsigned I = 0; I < ValuesToLink.size(); ++I) {
763caabe228SRafael Espindola     GlobalValue *GV = ValuesToLink[I];
764caabe228SRafael Espindola     const Comdat *SC = GV->getComdat();
765caabe228SRafael Espindola     if (!SC)
766caabe228SRafael Espindola       continue;
767caabe228SRafael Espindola     for (GlobalValue *GV2 : ComdatMembers[SC])
768caabe228SRafael Espindola       ValuesToLink.insert(GV2);
769caabe228SRafael Espindola   }
770caabe228SRafael Espindola 
771caabe228SRafael Espindola   if (shouldInternalizeLinkedSymbols()) {
772caabe228SRafael Espindola     for (GlobalValue *GV : ValuesToLink)
773caabe228SRafael Espindola       Internalize.insert(GV->getName());
774caabe228SRafael Espindola   }
775caabe228SRafael Espindola 
776f81c7b03SRafael Espindola   if (Mover.move(SrcM, ValuesToLink.getArrayRef(),
777caabe228SRafael Espindola                  [this](GlobalValue &GV, IRMover::ValueAdder Add) {
778caabe228SRafael Espindola                    addLazyFor(GV, Add);
779caabe228SRafael Espindola                  }))
7804b5ec263SRafael Espindola     return true;
781caabe228SRafael Espindola   Module &DstM = Mover.getModule();
782caabe228SRafael Espindola   for (auto &P : Internalize) {
783caabe228SRafael Espindola     GlobalValue *GV = DstM.getNamedValue(P.first());
784caabe228SRafael Espindola     GV->setLinkage(GlobalValue::InternalLinkage);
785beadd56aSRafael Espindola   }
786beadd56aSRafael Espindola 
7872609888fSAnton Korobeynikov   return false;
7882609888fSAnton Korobeynikov }
789361e513dSReid Spencer 
790*9d2bfc48SRafael Espindola Linker::Linker(Module &M) : Mover(M) {}
7913df61b7bSRafael Espindola 
7920e309fe8SRafael Espindola bool Linker::linkInModule(Module &Src, unsigned Flags,
7938220e8a8SMehdi Amini                           const FunctionInfoIndex *Index,
7947471cf81SMehdi Amini                           DenseSet<const GlobalValue *> *FunctionsToImport) {
795caabe228SRafael Espindola   ModuleLinker TheLinker(Mover, Src, Flags, Index, FunctionsToImport);
796caabe228SRafael Espindola   return TheLinker.run();
7973df61b7bSRafael Espindola }
7983df61b7bSRafael Espindola 
799b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
800b1ed91f3SChris Lattner // LinkModules entrypoint.
801b1ed91f3SChris Lattner //===----------------------------------------------------------------------===//
802b1ed91f3SChris Lattner 
80318c89411SRafael Espindola /// This function links two modules together, with the resulting Dest module
80418c89411SRafael Espindola /// modified to be the composite of the two input modules. If an error occurs,
80518c89411SRafael Espindola /// true is returned and ErrorMsg (if not null) is set to indicate the problem.
80618c89411SRafael Espindola /// Upon failure, the Dest module could be in a modified state, and shouldn't be
80718c89411SRafael Espindola /// relied on to be consistent.
808*9d2bfc48SRafael Espindola bool Linker::linkModules(Module &Dest, Module &Src, unsigned Flags) {
809*9d2bfc48SRafael Espindola   Linker L(Dest);
810020d4fb1SArtem Belevich   return L.linkInModule(Src, Flags);
8114160f5d3SRafael Espindola }
8124160f5d3SRafael Espindola 
813bae7e759STeresa Johnson std::unique_ptr<Module>
814bae7e759STeresa Johnson llvm::renameModuleForThinLTO(std::unique_ptr<Module> &M,
815*9d2bfc48SRafael Espindola                              const FunctionInfoIndex *Index) {
816bae7e759STeresa Johnson   std::unique_ptr<llvm::Module> RenamedModule(
817bae7e759STeresa Johnson       new llvm::Module(M->getModuleIdentifier(), M->getContext()));
818*9d2bfc48SRafael Espindola   Linker L(*RenamedModule.get());
819bae7e759STeresa Johnson   if (L.linkInModule(*M.get(), llvm::Linker::Flags::None, Index))
820bae7e759STeresa Johnson     return nullptr;
821bae7e759STeresa Johnson   return RenamedModule;
822bae7e759STeresa Johnson }
823bae7e759STeresa Johnson 
824a3aeb980SBill Wendling //===----------------------------------------------------------------------===//
825a3aeb980SBill Wendling // C API.
826a3aeb980SBill Wendling //===----------------------------------------------------------------------===//
827a3aeb980SBill Wendling 
828*9d2bfc48SRafael Espindola static void diagnosticHandler(const DiagnosticInfo &DI, void *C) {
829*9d2bfc48SRafael Espindola   auto *Message = reinterpret_cast<std::string *>(C);
830*9d2bfc48SRafael Espindola   raw_string_ostream Stream(*Message);
831*9d2bfc48SRafael Espindola   DiagnosticPrinterRawOStream DP(Stream);
832*9d2bfc48SRafael Espindola   DI.print(DP);
833*9d2bfc48SRafael Espindola }
834*9d2bfc48SRafael Espindola 
835a3aeb980SBill Wendling LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
836a57d588cSJuergen Ributzka                          LLVMLinkerMode Unused, char **OutMessages) {
83798ab63ceSRafael Espindola   Module *D = unwrap(Dest);
838*9d2bfc48SRafael Espindola   LLVMContext &Ctx = D->getContext();
839*9d2bfc48SRafael Espindola 
840*9d2bfc48SRafael Espindola   LLVMContext::DiagnosticHandlerTy OldDiagnosticHandler =
841*9d2bfc48SRafael Espindola       Ctx.getDiagnosticHandler();
842*9d2bfc48SRafael Espindola   void *OldDiagnosticContext = Ctx.getDiagnosticContext();
84398ab63ceSRafael Espindola   std::string Message;
844*9d2bfc48SRafael Espindola   Ctx.setDiagnosticHandler(diagnosticHandler, &Message, true);
8454160f5d3SRafael Espindola 
846*9d2bfc48SRafael Espindola   LLVMBool Result = Linker::linkModules(*D, *unwrap(Src));
84798ab63ceSRafael Espindola 
848*9d2bfc48SRafael Espindola   Ctx.setDiagnosticHandler(OldDiagnosticHandler, OldDiagnosticContext, true);
849*9d2bfc48SRafael Espindola 
850*9d2bfc48SRafael Espindola   if (OutMessages && Result)
85198ab63ceSRafael Espindola     *OutMessages = strdup(Message.c_str());
852a3aeb980SBill Wendling   return Result;
853a3aeb980SBill Wendling }
854