lib/Linker/LinkModules.cpp

   1 //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===//
   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 the LLVM module linker.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Linker/Linker.h"
  15 #include "llvm-c/Linker.h"
  16 #include "llvm/ADT/Hashing.h"
  17 #include "llvm/ADT/Optional.h"
  18 #include "llvm/ADT/SetVector.h"
  19 #include "llvm/ADT/SmallString.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/ADT/Triple.h"
  22 #include "llvm/IR/Constants.h"
  23 #include "llvm/IR/DebugInfo.h"
  24 #include "llvm/IR/DiagnosticInfo.h"
  25 #include "llvm/IR/DiagnosticPrinter.h"
  26 #include "llvm/IR/LLVMContext.h"
  27 #include "llvm/IR/Module.h"
  28 #include "llvm/IR/TypeFinder.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Transforms/Utils/Cloning.h"
  33 #include <cctype>
  34 #include <tuple>
  35 using namespace llvm;
  36
  37
  38 //===----------------------------------------------------------------------===//
  39 // TypeMap implementation.
  40 //===----------------------------------------------------------------------===//
  41
  42 namespace {
  43 class TypeMapTy : public ValueMapTypeRemapper {
  44   /// This is a mapping from a source type to a destination type to use.
  45   DenseMap<Type*, Type*> MappedTypes;
  46
  47   /// When checking to see if two subgraphs are isomorphic, we speculatively
  48   /// add types to MappedTypes, but keep track of them here in case we need to
  49   /// roll back.
  50   SmallVector<Type*, 16> SpeculativeTypes;
  51
  52   SmallVector<StructType*, 16> SpeculativeDstOpaqueTypes;
  53
  54   /// This is a list of non-opaque structs in the source module that are mapped
  55   /// to an opaque struct in the destination module.
  56   SmallVector<StructType*, 16> SrcDefinitionsToResolve;
  57
  58   /// This is the set of opaque types in the destination modules who are
  59   /// getting a body from the source module.
  60   SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes;
  61
  62 public:
  63   TypeMapTy(Linker::IdentifiedStructTypeSet &DstStructTypesSet)
  64       : DstStructTypesSet(DstStructTypesSet) {}
  65
  66   Linker::IdentifiedStructTypeSet &DstStructTypesSet;
  67   /// Indicate that the specified type in the destination module is conceptually
  68   /// equivalent to the specified type in the source module.
  69   void addTypeMapping(Type *DstTy, Type *SrcTy);
  70
  71   /// Produce a body for an opaque type in the dest module from a type
  72   /// definition in the source module.
  73   void linkDefinedTypeBodies();
  74
  75   /// Return the mapped type to use for the specified input type from the
  76   /// source module.
  77   Type *get(Type *SrcTy);
  78   Type *get(Type *SrcTy, SmallPtrSet<StructType *, 8> &Visited);
  79
  80   void finishType(StructType *DTy, StructType *STy, ArrayRef<Type *> ETypes);
  81
  82   FunctionType *get(FunctionType *T) {
  83     return cast<FunctionType>(get((Type *)T));
  84   }
  85
  86   /// Dump out the type map for debugging purposes.
  87   void dump() const {
  88     for (auto &Pair : MappedTypes) {
  89       dbgs() << "TypeMap: ";
  90       Pair.first->print(dbgs());
  91       dbgs() << " => ";
  92       Pair.second->print(dbgs());
  93       dbgs() << '\n';
  94     }
  95   }
  96
  97 private:
  98   Type *remapType(Type *SrcTy) override { return get(SrcTy); }
  99
 100   bool areTypesIsomorphic(Type *DstTy, Type *SrcTy);
 101 };
 102 }
 103
 104 void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) {
 105   assert(SpeculativeTypes.empty());
 106   assert(SpeculativeDstOpaqueTypes.empty());
 107
 108   // Check to see if these types are recursively isomorphic and establish a
 109   // mapping between them if so.
 110   if (!areTypesIsomorphic(DstTy, SrcTy)) {
 111     // Oops, they aren't isomorphic.  Just discard this request by rolling out
 112     // any speculative mappings we've established.
 113     for (Type *Ty : SpeculativeTypes)
 114       MappedTypes.erase(Ty);
 115
 116     SrcDefinitionsToResolve.resize(SrcDefinitionsToResolve.size() -
 117                                    SpeculativeDstOpaqueTypes.size());
 118     for (StructType *Ty : SpeculativeDstOpaqueTypes)
 119       DstResolvedOpaqueTypes.erase(Ty);
 120   } else {
 121     for (Type *Ty : SpeculativeTypes)
 122       if (auto *STy = dyn_cast<StructType>(Ty))
 123         if (STy->hasName())
 124           STy->setName("");
 125   }
 126   SpeculativeTypes.clear();
 127   SpeculativeDstOpaqueTypes.clear();
 128 }
 129
 130 /// Recursively walk this pair of types, returning true if they are isomorphic,
 131 /// false if they are not.
 132 bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) {
 133   // Two types with differing kinds are clearly not isomorphic.
 134   if (DstTy->getTypeID() != SrcTy->getTypeID())
 135     return false;
 136
 137   // If we have an entry in the MappedTypes table, then we have our answer.
 138   Type *&Entry = MappedTypes[SrcTy];
 139   if (Entry)
 140     return Entry == DstTy;
 141
 142   // Two identical types are clearly isomorphic.  Remember this
 143   // non-speculatively.
 144   if (DstTy == SrcTy) {
 145     Entry = DstTy;
 146     return true;
 147   }
 148
 149   // Okay, we have two types with identical kinds that we haven't seen before.
 150
 151   // If this is an opaque struct type, special case it.
 152   if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) {
 153     // Mapping an opaque type to any struct, just keep the dest struct.
 154     if (SSTy->isOpaque()) {
 155       Entry = DstTy;
 156       SpeculativeTypes.push_back(SrcTy);
 157       return true;
 158     }
 159
 160     // Mapping a non-opaque source type to an opaque dest.  If this is the first
 161     // type that we're mapping onto this destination type then we succeed.  Keep
 162     // the dest, but fill it in later. If this is the second (different) type
 163     // that we're trying to map onto the same opaque type then we fail.
 164     if (cast<StructType>(DstTy)->isOpaque()) {
 165       // We can only map one source type onto the opaque destination type.
 166       if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy)).second)
 167         return false;
 168       SrcDefinitionsToResolve.push_back(SSTy);
 169       SpeculativeTypes.push_back(SrcTy);
 170       SpeculativeDstOpaqueTypes.push_back(cast<StructType>(DstTy));
 171       Entry = DstTy;
 172       return true;
 173     }
 174   }
 175
 176   // If the number of subtypes disagree between the two types, then we fail.
 177   if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes())
 178     return false;
 179
 180   // Fail if any of the extra properties (e.g. array size) of the type disagree.
 181   if (isa<IntegerType>(DstTy))
 182     return false;  // bitwidth disagrees.
 183   if (PointerType *PT = dyn_cast<PointerType>(DstTy)) {
 184     if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace())
 185       return false;
 186
 187   } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) {
 188     if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg())
 189       return false;
 190   } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) {
 191     StructType *SSTy = cast<StructType>(SrcTy);
 192     if (DSTy->isLiteral() != SSTy->isLiteral() ||
 193         DSTy->isPacked() != SSTy->isPacked())
 194       return false;
 195   } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) {
 196     if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
 197       return false;
 198   } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
 199     if (DVTy->getNumElements() != cast<VectorType>(SrcTy)->getNumElements())
 200       return false;
 201   }
 202
 203   // Otherwise, we speculate that these two types will line up and recursively
 204   // check the subelements.
 205   Entry = DstTy;
 206   SpeculativeTypes.push_back(SrcTy);
 207
 208   for (unsigned I = 0, E = SrcTy->getNumContainedTypes(); I != E; ++I)
 209     if (!areTypesIsomorphic(DstTy->getContainedType(I),
 210                             SrcTy->getContainedType(I)))
 211       return false;
 212
 213   // If everything seems to have lined up, then everything is great.
 214   return true;
 215 }
 216
 217 void TypeMapTy::linkDefinedTypeBodies() {
 218   SmallVector<Type*, 16> Elements;
 219   for (StructType *SrcSTy : SrcDefinitionsToResolve) {
 220     StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]);
 221     assert(DstSTy->isOpaque());
 222
 223     // Map the body of the source type over to a new body for the dest type.
 224     Elements.resize(SrcSTy->getNumElements());
 225     for (unsigned I = 0, E = Elements.size(); I != E; ++I)
 226       Elements[I] = get(SrcSTy->getElementType(I));
 227
 228     DstSTy->setBody(Elements, SrcSTy->isPacked());
 229     DstStructTypesSet.switchToNonOpaque(DstSTy);
 230   }
 231   SrcDefinitionsToResolve.clear();
 232   DstResolvedOpaqueTypes.clear();
 233 }
 234
 235 void TypeMapTy::finishType(StructType *DTy, StructType *STy,
 236                            ArrayRef<Type *> ETypes) {
 237   DTy->setBody(ETypes, STy->isPacked());
 238
 239   // Steal STy's name.
 240   if (STy->hasName()) {
 241     SmallString<16> TmpName = STy->getName();
 242     STy->setName("");
 243     DTy->setName(TmpName);
 244   }
 245
 246   DstStructTypesSet.addNonOpaque(DTy);
 247 }
 248
 249 Type *TypeMapTy::get(Type *Ty) {
 250   SmallPtrSet<StructType *, 8> Visited;
 251   return get(Ty, Visited);
 252 }
 253
 254 Type *TypeMapTy::get(Type *Ty, SmallPtrSet<StructType *, 8> &Visited) {
 255   // If we already have an entry for this type, return it.
 256   Type **Entry = &MappedTypes[Ty];
 257   if (*Entry)
 258     return *Entry;
 259
 260   // These are types that LLVM itself will unique.
 261   bool IsUniqued = !isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral();
 262
 263 #ifndef NDEBUG
 264   if (!IsUniqued) {
 265     for (auto &Pair : MappedTypes) {
 266       assert(!(Pair.first != Ty && Pair.second == Ty) &&
 267              "mapping to a source type");
 268     }
 269   }
 270 #endif
 271
 272   if (!IsUniqued && !Visited.insert(cast<StructType>(Ty)).second) {
 273     StructType *DTy = StructType::create(Ty->getContext());
 274     return *Entry = DTy;
 275   }
 276
 277   // If this is not a recursive type, then just map all of the elements and
 278   // then rebuild the type from inside out.
 279   SmallVector<Type *, 4> ElementTypes;
 280
 281   // If there are no element types to map, then the type is itself.  This is
 282   // true for the anonymous {} struct, things like 'float', integers, etc.
 283   if (Ty->getNumContainedTypes() == 0 && IsUniqued)
 284     return *Entry = Ty;
 285
 286   // Remap all of the elements, keeping track of whether any of them change.
 287   bool AnyChange = false;
 288   ElementTypes.resize(Ty->getNumContainedTypes());
 289   for (unsigned I = 0, E = Ty->getNumContainedTypes(); I != E; ++I) {
 290     ElementTypes[I] = get(Ty->getContainedType(I), Visited);
 291     AnyChange |= ElementTypes[I] != Ty->getContainedType(I);
 292   }
 293
 294   // If we found our type while recursively processing stuff, just use it.
 295   Entry = &MappedTypes[Ty];
 296   if (*Entry) {
 297     if (auto *DTy = dyn_cast<StructType>(*Entry)) {
 298       if (DTy->isOpaque()) {
 299         auto *STy = cast<StructType>(Ty);
 300         finishType(DTy, STy, ElementTypes);
 301       }
 302     }
 303     return *Entry;
 304   }
 305
 306   // If all of the element types mapped directly over and the type is not
 307   // a nomed struct, then the type is usable as-is.
 308   if (!AnyChange && IsUniqued)
 309     return *Entry = Ty;
 310
 311   // Otherwise, rebuild a modified type.
 312   switch (Ty->getTypeID()) {
 313   default:
 314     llvm_unreachable("unknown derived type to remap");
 315   case Type::ArrayTyID:
 316     return *Entry = ArrayType::get(ElementTypes[0],
 317                                    cast<ArrayType>(Ty)->getNumElements());
 318   case Type::VectorTyID:
 319     return *Entry = VectorType::get(ElementTypes[0],
 320                                     cast<VectorType>(Ty)->getNumElements());
 321   case Type::PointerTyID:
 322     return *Entry = PointerType::get(ElementTypes[0],
 323                                      cast<PointerType>(Ty)->getAddressSpace());
 324   case Type::FunctionTyID:
 325     return *Entry = FunctionType::get(ElementTypes[0],
 326                                       makeArrayRef(ElementTypes).slice(1),
 327                                       cast<FunctionType>(Ty)->isVarArg());
 328   case Type::StructTyID: {
 329     auto *STy = cast<StructType>(Ty);
 330     bool IsPacked = STy->isPacked();
 331     if (IsUniqued)
 332       return *Entry = StructType::get(Ty->getContext(), ElementTypes, IsPacked);
 333
 334     // If the type is opaque, we can just use it directly.
 335     if (STy->isOpaque()) {
 336       DstStructTypesSet.addOpaque(STy);
 337       return *Entry = Ty;
 338     }
 339
 340     if (StructType *OldT =
 341             DstStructTypesSet.findNonOpaque(ElementTypes, IsPacked)) {
 342       STy->setName("");
 343       return *Entry = OldT;
 344     }
 345
 346     if (!AnyChange) {
 347       DstStructTypesSet.addNonOpaque(STy);
 348       return *Entry = Ty;
 349     }
 350
 351     StructType *DTy = StructType::create(Ty->getContext());
 352     finishType(DTy, STy, ElementTypes);
 353     return *Entry = DTy;
 354   }
 355   }
 356 }
 357
 358 //===----------------------------------------------------------------------===//
 359 // ModuleLinker implementation.
 360 //===----------------------------------------------------------------------===//
 361
 362 namespace {
 363 class ModuleLinker;
 364
 365 /// Creates prototypes for functions that are lazily linked on the fly. This
 366 /// speeds up linking for modules with many/ lazily linked functions of which
 367 /// few get used.
 368 class ValueMaterializerTy final : public ValueMaterializer {
 369   TypeMapTy &TypeMap;
 370   Module *DstM;
 371   std::vector<GlobalValue *> &LazilyLinkGlobalValues;
 372   ModuleLinker *ModLinker;
 373
 374 public:
 375   ValueMaterializerTy(TypeMapTy &TypeMap, Module *DstM,
 376                       std::vector<GlobalValue *> &LazilyLinkGlobalValues,
 377                       ModuleLinker *ModLinker)
 378       : ValueMaterializer(), TypeMap(TypeMap), DstM(DstM),
 379         LazilyLinkGlobalValues(LazilyLinkGlobalValues), ModLinker(ModLinker) {}
 380
 381   Value *materializeValueFor(Value *V) override;
 382 };
 383
 384 class LinkDiagnosticInfo : public DiagnosticInfo {
 385   const Twine &Msg;
 386
 387 public:
 388   LinkDiagnosticInfo(DiagnosticSeverity Severity, const Twine &Msg);
 389   void print(DiagnosticPrinter &DP) const override;
 390 };
 391 LinkDiagnosticInfo::LinkDiagnosticInfo(DiagnosticSeverity Severity,
 392                                        const Twine &Msg)
 393     : DiagnosticInfo(DK_Linker, Severity), Msg(Msg) {}
 394 void LinkDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
 395
 396 /// This is an implementation class for the LinkModules function, which is the
 397 /// entrypoint for this file.
 398 class ModuleLinker {
 399   Module *DstM, *SrcM;
 400
 401   TypeMapTy TypeMap;
 402   ValueMaterializerTy ValMaterializer;
 403
 404   /// Mapping of values from what they used to be in Src, to what they are now
 405   /// in DstM.  ValueToValueMapTy is a ValueMap, which involves some overhead
 406   /// due to the use of Value handles which the Linker doesn't actually need,
 407   /// but this allows us to reuse the ValueMapper code.
 408   ValueToValueMapTy ValueMap;
 409
 410   struct AppendingVarInfo {
 411     GlobalVariable *NewGV;   // New aggregate global in dest module.
 412     const Constant *DstInit; // Old initializer from dest module.
 413     const Constant *SrcInit; // Old initializer from src module.
 414   };
 415
 416   std::vector<AppendingVarInfo> AppendingVars;
 417
 418   // Set of items not to link in from source.
 419   SmallPtrSet<const Value *, 16> DoNotLinkFromSource;
 420
 421   // Vector of GlobalValues to lazily link in.
 422   std::vector<GlobalValue *> LazilyLinkGlobalValues;
 423
 424   /// Functions that have replaced other functions.
 425   SmallPtrSet<const Function *, 16> OverridingFunctions;
 426
 427   DiagnosticHandlerFunction DiagnosticHandler;
 428
 429   /// For symbol clashes, prefer those from Src.
 430   unsigned Flags;
 431
 432   /// Function index passed into ModuleLinker for using in function
 433   /// importing/exporting handling.
 434   FunctionInfoIndex *ImportIndex;
 435
 436   /// Function to import from source module, all other functions are
 437   /// imported as declarations instead of definitions.
 438   Function *ImportFunction;
 439
 440   /// Set to true if the given FunctionInfoIndex contains any functions
 441   /// from this source module, in which case we must conservatively assume
 442   /// that any of its functions may be imported into another module
 443   /// as part of a different backend compilation process.
 444   bool HasExportedFunctions;
 445
 446 public:
 447   ModuleLinker(Module *dstM, Linker::IdentifiedStructTypeSet &Set, Module *srcM,
 448                DiagnosticHandlerFunction DiagnosticHandler, unsigned Flags,
 449                FunctionInfoIndex *Index = nullptr,
 450                Function *FuncToImport = nullptr)
 451       : DstM(dstM), SrcM(srcM), TypeMap(Set),
 452         ValMaterializer(TypeMap, DstM, LazilyLinkGlobalValues, this),
 453         DiagnosticHandler(DiagnosticHandler), Flags(Flags), ImportIndex(Index),
 454         ImportFunction(FuncToImport), HasExportedFunctions(false) {
 455     assert((ImportIndex || !ImportFunction) &&
 456            "Expect a FunctionInfoIndex when importing");
 457     // If we have a FunctionInfoIndex but no function to import,
 458     // then this is the primary module being compiled in a ThinLTO
 459     // backend compilation, and we need to see if it has functions that
 460     // may be exported to another backend compilation.
 461     if (ImportIndex && !ImportFunction)
 462       HasExportedFunctions = ImportIndex->hasExportedFunctions(SrcM);
 463   }
 464
 465   bool run();
 466
 467   bool shouldOverrideFromSrc() { return Flags & Linker::OverrideFromSrc; }
 468   bool shouldLinkOnlyNeeded() { return Flags & Linker::LinkOnlyNeeded; }
 469   bool shouldInternalizeLinkedSymbols() {
 470     return Flags & Linker::InternalizeLinkedSymbols;
 471   }
 472
 473   /// Handles cloning of a global values from the source module into
 474   /// the destination module, including setting the attributes and visibility.
 475   GlobalValue *copyGlobalValueProto(TypeMapTy &TypeMap, const GlobalValue *SGV,
 476                                     const GlobalValue *DGV = nullptr);
 477
 478   /// Check if we should promote the given local value to global scope.
 479   bool doPromoteLocalToGlobal(const GlobalValue *SGV);
 480
 481 private:
 482   bool shouldLinkFromSource(bool &LinkFromSrc, const GlobalValue &Dest,
 483                             const GlobalValue &Src);
 484
 485   /// Helper method for setting a message and returning an error code.
 486   bool emitError(const Twine &Message) {
 487     DiagnosticHandler(LinkDiagnosticInfo(DS_Error, Message));
 488     return true;
 489   }
 490
 491   void emitWarning(const Twine &Message) {
 492     DiagnosticHandler(LinkDiagnosticInfo(DS_Warning, Message));
 493   }
 494
 495   bool getComdatLeader(Module *M, StringRef ComdatName,
 496                        const GlobalVariable *&GVar);
 497   bool computeResultingSelectionKind(StringRef ComdatName,
 498                                      Comdat::SelectionKind Src,
 499                                      Comdat::SelectionKind Dst,
 500                                      Comdat::SelectionKind &Result,
 501                                      bool &LinkFromSrc);
 502   std::map<const Comdat *, std::pair<Comdat::SelectionKind, bool>>
 503       ComdatsChosen;
 504   bool getComdatResult(const Comdat *SrcC, Comdat::SelectionKind &SK,
 505                        bool &LinkFromSrc);
 506
 507   /// Given a global in the source module, return the global in the
 508   /// destination module that is being linked to, if any.
 509   GlobalValue *getLinkedToGlobal(const GlobalValue *SrcGV) {
 510     // If the source has no name it can't link.  If it has local linkage,
 511     // there is no name match-up going on.
 512     if (!SrcGV->hasName() || SrcGV->hasLocalLinkage())
 513       return nullptr;
 514
 515     // Otherwise see if we have a match in the destination module's symtab.
 516     GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName());
 517     if (!DGV)
 518       return nullptr;
 519
 520     // If we found a global with the same name in the dest module, but it has
 521     // internal linkage, we are really not doing any linkage here.
 522     if (DGV->hasLocalLinkage())
 523       return nullptr;
 524
 525     // Otherwise, we do in fact link to the destination global.
 526     return DGV;
 527   }
 528
 529   void computeTypeMapping();
 530
 531   void upgradeMismatchedGlobalArray(StringRef Name);
 532   void upgradeMismatchedGlobals();
 533
 534   bool linkAppendingVarProto(GlobalVariable *DstGV,
 535                              const GlobalVariable *SrcGV);
 536
 537   bool linkGlobalValueProto(GlobalValue *GV);
 538   bool linkModuleFlagsMetadata();
 539
 540   void linkAppendingVarInit(const AppendingVarInfo &AVI);
 541
 542   void linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src);
 543   bool linkFunctionBody(Function &Dst, Function &Src);
 544   void linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src);
 545   bool linkGlobalValueBody(GlobalValue &Src);
 546
 547   /// Functions that take care of cloning a specific global value type
 548   /// into the destination module.
 549   GlobalVariable *copyGlobalVariableProto(TypeMapTy &TypeMap,
 550                                           const GlobalVariable *SGVar);
 551   Function *copyFunctionProto(TypeMapTy &TypeMap, const Function *SF);
 552   GlobalValue *copyGlobalAliasProto(TypeMapTy &TypeMap, const GlobalAlias *SGA);
 553
 554   /// Helper methods to check if we are importing from or potentially
 555   /// exporting from the current source module.
 556   bool isPerformingImport() { return ImportFunction != nullptr; }
 557   bool isModuleExporting() { return HasExportedFunctions; }
 558
 559   /// If we are importing from the source module, checks if we should
 560   /// import SGV as a definition, otherwise import as a declaration.
 561   bool doImportAsDefinition(const GlobalValue *SGV);
 562
 563   /// Get the name for SGV that should be used in the linked destination
 564   /// module. Specifically, this handles the case where we need to rename
 565   /// a local that is being promoted to global scope.
 566   std::string getName(const GlobalValue *SGV);
 567
 568   /// Get the new linkage for SGV that should be used in the linked destination
 569   /// module. Specifically, for ThinLTO importing or exporting it may need
 570   /// to be adjusted.
 571   GlobalValue::LinkageTypes getLinkage(const GlobalValue *SGV);
 572
 573   /// Copies the necessary global value attributes and name from the source
 574   /// to the newly cloned global value.
 575   void copyGVAttributes(GlobalValue *NewGV, const GlobalValue *SrcGV);
 576
 577   /// Updates the visibility for the new global cloned from the source
 578   /// and, if applicable, linked with an existing destination global.
 579   /// Handles visibility change required for promoted locals.
 580   void setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
 581                      const GlobalValue *DGV = nullptr);
 582
 583   void linkNamedMDNodes();
 584   void stripReplacedSubprograms();
 585 };
 586 }
 587
 588 /// The LLVM SymbolTable class autorenames globals that conflict in the symbol
 589 /// table. This is good for all clients except for us. Go through the trouble
 590 /// to force this back.
 591 static void forceRenaming(GlobalValue *GV, StringRef Name) {
 592   // If the global doesn't force its name or if it already has the right name,
 593   // there is nothing for us to do.
 594   // Note that any required local to global promotion should already be done,
 595   // so promoted locals will not skip this handling as their linkage is no
 596   // longer local.
 597   if (GV->hasLocalLinkage() || GV->getName() == Name)
 598     return;
 599
 600   Module *M = GV->getParent();
 601
 602   // If there is a conflict, rename the conflict.
 603   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
 604     GV->takeName(ConflictGV);
 605     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
 606     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
 607   } else {
 608     GV->setName(Name);              // Force the name back
 609   }
 610 }
 611
 612 /// copy additional attributes (those not needed to construct a GlobalValue)
 613 /// from the SrcGV to the DestGV.
 614 void ModuleLinker::copyGVAttributes(GlobalValue *NewGV,
 615                                     const GlobalValue *SrcGV) {
 616   auto *GA = dyn_cast<GlobalAlias>(SrcGV);
 617   // Check for the special case of converting an alias (definition) to a
 618   // non-alias (declaration). This can happen when we are importing and
 619   // encounter a weak_any alias (weak_any defs may not be imported, see
 620   // comments in ModuleLinker::getLinkage) or an alias whose base object is
 621   // being imported as a declaration. In that case copy the attributes from the
 622   // base object.
 623   if (GA && !dyn_cast<GlobalAlias>(NewGV)) {
 624     assert(isPerformingImport() &&
 625            (GA->hasWeakAnyLinkage() ||
 626             !doImportAsDefinition(GA->getBaseObject())));
 627     NewGV->copyAttributesFrom(GA->getBaseObject());
 628   } else
 629     NewGV->copyAttributesFrom(SrcGV);
 630   forceRenaming(NewGV, getName(SrcGV));
 631 }
 632
 633 static bool isLessConstraining(GlobalValue::VisibilityTypes a,
 634                                GlobalValue::VisibilityTypes b) {
 635   if (a == GlobalValue::HiddenVisibility)
 636     return false;
 637   if (b == GlobalValue::HiddenVisibility)
 638     return true;
 639   if (a == GlobalValue::ProtectedVisibility)
 640     return false;
 641   if (b == GlobalValue::ProtectedVisibility)
 642     return true;
 643   return false;
 644 }
 645
 646 bool ModuleLinker::doImportAsDefinition(const GlobalValue *SGV) {
 647   if (!isPerformingImport())
 648     return false;
 649   // Always import GlobalVariable definitions. The linkage changes
 650   // described in ModuleLinker::getLinkage ensure the correct behavior (e.g.
 651   // global variables with external linkage are transformed to
 652   // available_externally defintions, which are ultimately turned into
 653   // declaratios after the EliminateAvailableExternally pass).
 654   if (dyn_cast<GlobalVariable>(SGV) && !SGV->isDeclaration())
 655     return true;
 656   // Only import the function requested for importing.
 657   auto *SF = dyn_cast<Function>(SGV);
 658   if (SF && SF == ImportFunction)
 659     return true;
 660   // Otherwise no.
 661   return false;
 662 }
 663
 664 bool ModuleLinker::doPromoteLocalToGlobal(const GlobalValue *SGV) {
 665   assert(SGV->hasLocalLinkage());
 666   // Both the imported references and the original local variable must
 667   // be promoted.
 668   if (!isPerformingImport() && !isModuleExporting())
 669     return false;
 670
 671   // Local const variables never need to be promoted unless they are address
 672   // taken. The imported uses can simply use the clone created in this module.
 673   // For now we are conservative in determining which variables are not
 674   // address taken by checking the unnamed addr flag. To be more aggressive,
 675   // the address taken information must be checked earlier during parsing
 676   // of the module and recorded in the function index for use when importing
 677   // from that module.
 678   auto *GVar = dyn_cast<GlobalVariable>(SGV);
 679   if (GVar && GVar->isConstant() && GVar->hasUnnamedAddr())
 680     return false;
 681
 682   // Eventually we only need to promote functions in the exporting module that
 683   // are referenced by a potentially exported function (i.e. one that is in the
 684   // function index).
 685   return true;
 686 }
 687
 688 std::string ModuleLinker::getName(const GlobalValue *SGV) {
 689   // For locals that must be promoted to global scope, ensure that
 690   // the promoted name uniquely identifies the copy in the original module,
 691   // using the ID assigned during combined index creation. When importing,
 692   // we rename all locals (not just those that are promoted) in order to
 693   // avoid naming conflicts between locals imported from different modules.
 694   if (SGV->hasLocalLinkage() &&
 695       (doPromoteLocalToGlobal(SGV) || isPerformingImport()))
 696     return FunctionInfoIndex::getGlobalNameForLocal(
 697         SGV->getName(),
 698         ImportIndex->getModuleId(SGV->getParent()->getModuleIdentifier()));
 699   return SGV->getName();
 700 }
 701
 702 GlobalValue::LinkageTypes ModuleLinker::getLinkage(const GlobalValue *SGV) {
 703   // Any local variable that is referenced by an exported function needs
 704   // to be promoted to global scope. Since we don't currently know which
 705   // functions reference which local variables/functions, we must treat
 706   // all as potentially exported if this module is exporting anything.
 707   if (isModuleExporting()) {
 708     if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
 709       return GlobalValue::ExternalLinkage;
 710     return SGV->getLinkage();
 711   }
 712
 713   // Otherwise, if we aren't importing, no linkage change is needed.
 714   if (!isPerformingImport())
 715     return SGV->getLinkage();
 716
 717   switch (SGV->getLinkage()) {
 718   case GlobalValue::ExternalLinkage:
 719     // External defnitions are converted to available_externally
 720     // definitions upon import, so that they are available for inlining
 721     // and/or optimization, but are turned into declarations later
 722     // during the EliminateAvailableExternally pass.
 723     if (doImportAsDefinition(SGV))
 724       return GlobalValue::AvailableExternallyLinkage;
 725     // An imported external declaration stays external.
 726     return SGV->getLinkage();
 727
 728   case GlobalValue::AvailableExternallyLinkage:
 729     // An imported available_externally definition converts
 730     // to external if imported as a declaration.
 731     if (!doImportAsDefinition(SGV))
 732       return GlobalValue::ExternalLinkage;
 733     // An imported available_externally declaration stays that way.
 734     return SGV->getLinkage();
 735
 736   case GlobalValue::LinkOnceAnyLinkage:
 737   case GlobalValue::LinkOnceODRLinkage:
 738     // These both stay the same when importing the definition.
 739     // The ThinLTO pass will eventually force-import their definitions.
 740     return SGV->getLinkage();
 741
 742   case GlobalValue::WeakAnyLinkage:
 743     // Can't import weak_any definitions correctly, or we might change the
 744     // program semantics, since the linker will pick the first weak_any
 745     // definition and importing would change the order they are seen by the
 746     // linker. The module linking caller needs to enforce this.
 747     assert(!doImportAsDefinition(SGV));
 748     // If imported as a declaration, it becomes external_weak.
 749     return GlobalValue::ExternalWeakLinkage;
 750
 751   case GlobalValue::WeakODRLinkage:
 752     // For weak_odr linkage, there is a guarantee that all copies will be
 753     // equivalent, so the issue described above for weak_any does not exist,
 754     // and the definition can be imported. It can be treated similarly
 755     // to an imported externally visible global value.
 756     if (doImportAsDefinition(SGV))
 757       return GlobalValue::AvailableExternallyLinkage;
 758     else
 759       return GlobalValue::ExternalLinkage;
 760
 761   case GlobalValue::AppendingLinkage:
 762     // It would be incorrect to import an appending linkage variable,
 763     // since it would cause global constructors/destructors to be
 764     // executed multiple times. This should have already been handled
 765     // by linkGlobalValueProto.
 766     assert(false && "Cannot import appending linkage variable");
 767
 768   case GlobalValue::InternalLinkage:
 769   case GlobalValue::PrivateLinkage:
 770     // If we are promoting the local to global scope, it is handled
 771     // similarly to a normal externally visible global.
 772     if (doPromoteLocalToGlobal(SGV)) {
 773       if (doImportAsDefinition(SGV))
 774         return GlobalValue::AvailableExternallyLinkage;
 775       else
 776         return GlobalValue::ExternalLinkage;
 777     }
 778     // A non-promoted imported local definition stays local.
 779     // The ThinLTO pass will eventually force-import their definitions.
 780     return SGV->getLinkage();
 781
 782   case GlobalValue::ExternalWeakLinkage:
 783     // External weak doesn't apply to definitions, must be a declaration.
 784     assert(!doImportAsDefinition(SGV));
 785     // Linkage stays external_weak.
 786     return SGV->getLinkage();
 787
 788   case GlobalValue::CommonLinkage:
 789     // Linkage stays common on definitions.
 790     // The ThinLTO pass will eventually force-import their definitions.
 791     return SGV->getLinkage();
 792   }
 793
 794   llvm_unreachable("unknown linkage type");
 795 }
 796
 797 /// Loop through the global variables in the src module and merge them into the
 798 /// dest module.
 799 GlobalVariable *
 800 ModuleLinker::copyGlobalVariableProto(TypeMapTy &TypeMap,
 801                                       const GlobalVariable *SGVar) {
 802   // No linking to be performed or linking from the source: simply create an
 803   // identical version of the symbol over in the dest module... the
 804   // initializer will be filled in later by LinkGlobalInits.
 805   GlobalVariable *NewDGV = new GlobalVariable(
 806       *DstM, TypeMap.get(SGVar->getType()->getElementType()),
 807       SGVar->isConstant(), getLinkage(SGVar), /*init*/ nullptr, getName(SGVar),
 808       /*insertbefore*/ nullptr, SGVar->getThreadLocalMode(),
 809       SGVar->getType()->getAddressSpace());
 810
 811   return NewDGV;
 812 }
 813
 814 /// Link the function in the source module into the destination module if
 815 /// needed, setting up mapping information.
 816 Function *ModuleLinker::copyFunctionProto(TypeMapTy &TypeMap,
 817                                           const Function *SF) {
 818   // If there is no linkage to be performed or we are linking from the source,
 819   // bring SF over.
 820   return Function::Create(TypeMap.get(SF->getFunctionType()), getLinkage(SF),
 821                           getName(SF), DstM);
 822 }
 823
 824 /// Set up prototypes for any aliases that come over from the source module.
 825 GlobalValue *ModuleLinker::copyGlobalAliasProto(TypeMapTy &TypeMap,
 826                                                 const GlobalAlias *SGA) {
 827   // If we are importing and encounter a weak_any alias, or an alias to
 828   // an object being imported as a declaration, we must import the alias
 829   // as a declaration as well, which involves converting it to a non-alias.
 830   // See comments in ModuleLinker::getLinkage for why we cannot import
 831   // weak_any defintions.
 832   if (isPerformingImport() && (SGA->hasWeakAnyLinkage() ||
 833                                !doImportAsDefinition(SGA->getBaseObject()))) {
 834     // Need to convert to declaration. All aliases must be definitions.
 835     const GlobalValue *GVal = SGA->getBaseObject();
 836     GlobalValue *NewGV;
 837     if (auto *GVar = dyn_cast<GlobalVariable>(GVal))
 838       NewGV = copyGlobalVariableProto(TypeMap, GVar);
 839     else {
 840       auto *F = dyn_cast<Function>(GVal);
 841       assert(F);
 842       NewGV = copyFunctionProto(TypeMap, F);
 843     }
 844     // Set the linkage to ExternalWeak, see also comments in
 845     // ModuleLinker::getLinkage.
 846     if (SGA->hasWeakAnyLinkage())
 847       NewGV->setLinkage(GlobalValue::ExternalWeakLinkage);
 848     // Don't attempt to link body, needs to be a declaration.
 849     DoNotLinkFromSource.insert(SGA);
 850     return NewGV;
 851   }
 852   // If there is no linkage to be performed or we're linking from the source,
 853   // bring over SGA.
 854   auto *Ty = TypeMap.get(SGA->getValueType());
 855   return GlobalAlias::create(Ty, SGA->getType()->getPointerAddressSpace(),
 856                              getLinkage(SGA), getName(SGA), DstM);
 857 }
 858
 859 void ModuleLinker::setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
 860                                  const GlobalValue *DGV) {
 861   GlobalValue::VisibilityTypes Visibility = SGV->getVisibility();
 862   if (DGV)
 863     Visibility = isLessConstraining(Visibility, DGV->getVisibility())
 864                      ? DGV->getVisibility()
 865                      : Visibility;
 866   // For promoted locals, mark them hidden so that they can later be
 867   // stripped from the symbol table to reduce bloat.
 868   if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
 869     Visibility = GlobalValue::HiddenVisibility;
 870   NewGV->setVisibility(Visibility);
 871 }
 872
 873 GlobalValue *ModuleLinker::copyGlobalValueProto(TypeMapTy &TypeMap,
 874                                                 const GlobalValue *SGV,
 875                                                 const GlobalValue *DGV) {
 876   GlobalValue *NewGV;
 877   if (auto *SGVar = dyn_cast<GlobalVariable>(SGV))
 878     NewGV = copyGlobalVariableProto(TypeMap, SGVar);
 879   else if (auto *SF = dyn_cast<Function>(SGV))
 880     NewGV = copyFunctionProto(TypeMap, SF);
 881   else
 882     NewGV = copyGlobalAliasProto(TypeMap, cast<GlobalAlias>(SGV));
 883   copyGVAttributes(NewGV, SGV);
 884   setVisibility(NewGV, SGV, DGV);
 885   return NewGV;
 886 }
 887
 888 Value *ValueMaterializerTy::materializeValueFor(Value *V) {
 889   auto *SGV = dyn_cast<GlobalValue>(V);
 890   if (!SGV)
 891     return nullptr;
 892
 893   GlobalValue *DGV = ModLinker->copyGlobalValueProto(TypeMap, SGV);
 894
 895   if (Comdat *SC = SGV->getComdat()) {
 896     if (auto *DGO = dyn_cast<GlobalObject>(DGV)) {
 897       Comdat *DC = DstM->getOrInsertComdat(SC->getName());
 898       DGO->setComdat(DC);
 899     }
 900   }
 901
 902   LazilyLinkGlobalValues.push_back(SGV);
 903   return DGV;
 904 }
 905
 906 bool ModuleLinker::getComdatLeader(Module *M, StringRef ComdatName,
 907                                    const GlobalVariable *&GVar) {
 908   const GlobalValue *GVal = M->getNamedValue(ComdatName);
 909   if (const auto *GA = dyn_cast_or_null<GlobalAlias>(GVal)) {
 910     GVal = GA->getBaseObject();
 911     if (!GVal)
 912       // We cannot resolve the size of the aliasee yet.
 913       return emitError("Linking COMDATs named '" + ComdatName +
 914                        "': COMDAT key involves incomputable alias size.");
 915   }
 916
 917   GVar = dyn_cast_or_null<GlobalVariable>(GVal);
 918   if (!GVar)
 919     return emitError(
 920         "Linking COMDATs named '" + ComdatName +
 921         "': GlobalVariable required for data dependent selection!");
 922
 923   return false;
 924 }
 925
 926 bool ModuleLinker::computeResultingSelectionKind(StringRef ComdatName,
 927                                                  Comdat::SelectionKind Src,
 928                                                  Comdat::SelectionKind Dst,
 929                                                  Comdat::SelectionKind &Result,
 930                                                  bool &LinkFromSrc) {
 931   // The ability to mix Comdat::SelectionKind::Any with
 932   // Comdat::SelectionKind::Largest is a behavior that comes from COFF.
 933   bool DstAnyOrLargest = Dst == Comdat::SelectionKind::Any ||
 934                          Dst == Comdat::SelectionKind::Largest;
 935   bool SrcAnyOrLargest = Src == Comdat::SelectionKind::Any ||
 936                          Src == Comdat::SelectionKind::Largest;
 937   if (DstAnyOrLargest && SrcAnyOrLargest) {
 938     if (Dst == Comdat::SelectionKind::Largest ||
 939         Src == Comdat::SelectionKind::Largest)
 940       Result = Comdat::SelectionKind::Largest;
 941     else
 942       Result = Comdat::SelectionKind::Any;
 943   } else if (Src == Dst) {
 944     Result = Dst;
 945   } else {
 946     return emitError("Linking COMDATs named '" + ComdatName +
 947                      "': invalid selection kinds!");
 948   }
 949
 950   switch (Result) {
 951   case Comdat::SelectionKind::Any:
 952     // Go with Dst.
 953     LinkFromSrc = false;
 954     break;
 955   case Comdat::SelectionKind::NoDuplicates:
 956     return emitError("Linking COMDATs named '" + ComdatName +
 957                      "': noduplicates has been violated!");
 958   case Comdat::SelectionKind::ExactMatch:
 959   case Comdat::SelectionKind::Largest:
 960   case Comdat::SelectionKind::SameSize: {
 961     const GlobalVariable *DstGV;
 962     const GlobalVariable *SrcGV;
 963     if (getComdatLeader(DstM, ComdatName, DstGV) ||
 964         getComdatLeader(SrcM, ComdatName, SrcGV))
 965       return true;
 966
 967     const DataLayout &DstDL = DstM->getDataLayout();
 968     const DataLayout &SrcDL = SrcM->getDataLayout();
 969     uint64_t DstSize =
 970         DstDL.getTypeAllocSize(DstGV->getType()->getPointerElementType());
 971     uint64_t SrcSize =
 972         SrcDL.getTypeAllocSize(SrcGV->getType()->getPointerElementType());
 973     if (Result == Comdat::SelectionKind::ExactMatch) {
 974       if (SrcGV->getInitializer() != DstGV->getInitializer())
 975         return emitError("Linking COMDATs named '" + ComdatName +
 976                          "': ExactMatch violated!");
 977       LinkFromSrc = false;
 978     } else if (Result == Comdat::SelectionKind::Largest) {
 979       LinkFromSrc = SrcSize > DstSize;
 980     } else if (Result == Comdat::SelectionKind::SameSize) {
 981       if (SrcSize != DstSize)
 982         return emitError("Linking COMDATs named '" + ComdatName +
 983                          "': SameSize violated!");
 984       LinkFromSrc = false;
 985     } else {
 986       llvm_unreachable("unknown selection kind");
 987     }
 988     break;
 989   }
 990   }
 991
 992   return false;
 993 }
 994
 995 bool ModuleLinker::getComdatResult(const Comdat *SrcC,
 996                                    Comdat::SelectionKind &Result,
 997                                    bool &LinkFromSrc) {
 998   Comdat::SelectionKind SSK = SrcC->getSelectionKind();
 999   StringRef ComdatName = SrcC->getName();
1000   Module::ComdatSymTabType &ComdatSymTab = DstM->getComdatSymbolTable();
1001   Module::ComdatSymTabType::iterator DstCI = ComdatSymTab.find(ComdatName);
1002
1003   if (DstCI == ComdatSymTab.end()) {
1004     // Use the comdat if it is only available in one of the modules.
1005     LinkFromSrc = true;
1006     Result = SSK;
1007     return false;
1008   }
1009
1010   const Comdat *DstC = &DstCI->second;
1011   Comdat::SelectionKind DSK = DstC->getSelectionKind();
1012   return computeResultingSelectionKind(ComdatName, SSK, DSK, Result,
1013                                        LinkFromSrc);
1014 }
1015
1016 bool ModuleLinker::shouldLinkFromSource(bool &LinkFromSrc,
1017                                         const GlobalValue &Dest,
1018                                         const GlobalValue &Src) {
1019   // Should we unconditionally use the Src?
1020   if (shouldOverrideFromSrc()) {
1021     LinkFromSrc = true;
1022     return false;
1023   }
1024
1025   // We always have to add Src if it has appending linkage.
1026   if (Src.hasAppendingLinkage()) {
1027     // Caller should have already determined that we can't link from source
1028     // when importing (see comments in linkGlobalValueProto).
1029     assert(!isPerformingImport());
1030     LinkFromSrc = true;
1031     return false;
1032   }
1033
1034   bool SrcIsDeclaration = Src.isDeclarationForLinker();
1035   bool DestIsDeclaration = Dest.isDeclarationForLinker();
1036
1037   if (isPerformingImport()) {
1038     if (isa<Function>(&Src)) {
1039       // For functions, LinkFromSrc iff this is the function requested
1040       // for importing. For variables, decide below normally.
1041       LinkFromSrc = (&Src == ImportFunction);
1042       return false;
1043     }
1044
1045     // Check if this is an alias with an already existing definition
1046     // in Dest, which must have come from a prior importing pass from
1047     // the same Src module. Unlike imported function and variable
1048     // definitions, which are imported as available_externally and are
1049     // not definitions for the linker, that is not a valid linkage for
1050     // imported aliases which must be definitions. Simply use the existing
1051     // Dest copy.
1052     if (isa<GlobalAlias>(&Src) && !DestIsDeclaration) {
1053       assert(isa<GlobalAlias>(&Dest));
1054       LinkFromSrc = false;
1055       return false;
1056     }
1057   }
1058
1059   if (SrcIsDeclaration) {
1060     // If Src is external or if both Src & Dest are external..  Just link the
1061     // external globals, we aren't adding anything.
1062     if (Src.hasDLLImportStorageClass()) {
1063       // If one of GVs is marked as DLLImport, result should be dllimport'ed.
1064       LinkFromSrc = DestIsDeclaration;
1065       return false;
1066     }
1067     // If the Dest is weak, use the source linkage.
1068     LinkFromSrc = Dest.hasExternalWeakLinkage();
1069     return false;
1070   }
1071
1072   if (DestIsDeclaration) {
1073     // If Dest is external but Src is not:
1074     LinkFromSrc = true;
1075     return false;
1076   }
1077
1078   if (Src.hasCommonLinkage()) {
1079     if (Dest.hasLinkOnceLinkage() || Dest.hasWeakLinkage()) {
1080       LinkFromSrc = true;
1081       return false;
1082     }
1083
1084     if (!Dest.hasCommonLinkage()) {
1085       LinkFromSrc = false;
1086       return false;
1087     }
1088
1089     const DataLayout &DL = Dest.getParent()->getDataLayout();
1090     uint64_t DestSize = DL.getTypeAllocSize(Dest.getType()->getElementType());
1091     uint64_t SrcSize = DL.getTypeAllocSize(Src.getType()->getElementType());
1092     LinkFromSrc = SrcSize > DestSize;
1093     return false;
1094   }
1095
1096   if (Src.isWeakForLinker()) {
1097     assert(!Dest.hasExternalWeakLinkage());
1098     assert(!Dest.hasAvailableExternallyLinkage());
1099
1100     if (Dest.hasLinkOnceLinkage() && Src.hasWeakLinkage()) {
1101       LinkFromSrc = true;
1102       return false;
1103     }
1104
1105     LinkFromSrc = false;
1106     return false;
1107   }
1108
1109   if (Dest.isWeakForLinker()) {
1110     assert(Src.hasExternalLinkage());
1111     LinkFromSrc = true;
1112     return false;
1113   }
1114
1115   assert(!Src.hasExternalWeakLinkage());
1116   assert(!Dest.hasExternalWeakLinkage());
1117   assert(Dest.hasExternalLinkage() && Src.hasExternalLinkage() &&
1118          "Unexpected linkage type!");
1119   return emitError("Linking globals named '" + Src.getName() +
1120                    "': symbol multiply defined!");
1121 }
1122
1123 /// Loop over all of the linked values to compute type mappings.  For example,
1124 /// if we link "extern Foo *x" and "Foo *x = NULL", then we have two struct
1125 /// types 'Foo' but one got renamed when the module was loaded into the same
1126 /// LLVMContext.
1127 void ModuleLinker::computeTypeMapping() {
1128   for (GlobalValue &SGV : SrcM->globals()) {
1129     GlobalValue *DGV = getLinkedToGlobal(&SGV);
1130     if (!DGV)
1131       continue;
1132
1133     if (!DGV->hasAppendingLinkage() || !SGV.hasAppendingLinkage()) {
1134       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1135       continue;
1136     }
1137
1138     // Unify the element type of appending arrays.
1139     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
1140     ArrayType *SAT = cast<ArrayType>(SGV.getType()->getElementType());
1141     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
1142   }
1143
1144   for (GlobalValue &SGV : *SrcM) {
1145     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
1146       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1147   }
1148
1149   for (GlobalValue &SGV : SrcM->aliases()) {
1150     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
1151       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1152   }
1153
1154   // Incorporate types by name, scanning all the types in the source module.
1155   // At this point, the destination module may have a type "%foo = { i32 }" for
1156   // example.  When the source module got loaded into the same LLVMContext, if
1157   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
1158   std::vector<StructType *> Types = SrcM->getIdentifiedStructTypes();
1159   for (StructType *ST : Types) {
1160     if (!ST->hasName())
1161       continue;
1162
1163     // Check to see if there is a dot in the name followed by a digit.
1164     size_t DotPos = ST->getName().rfind('.');
1165     if (DotPos == 0 || DotPos == StringRef::npos ||
1166         ST->getName().back() == '.' ||
1167         !isdigit(static_cast<unsigned char>(ST->getName()[DotPos + 1])))
1168       continue;
1169
1170     // Check to see if the destination module has a struct with the prefix name.
1171     StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos));
1172     if (!DST)
1173       continue;
1174
1175     // Don't use it if this actually came from the source module. They're in
1176     // the same LLVMContext after all. Also don't use it unless the type is
1177     // actually used in the destination module. This can happen in situations
1178     // like this:
1179     //
1180     //      Module A                         Module B
1181     //      --------                         --------
1182     //   %Z = type { %A }                %B = type { %C.1 }
1183     //   %A = type { %B.1, [7 x i8] }    %C.1 = type { i8* }
1184     //   %B.1 = type { %C }              %A.2 = type { %B.3, [5 x i8] }
1185     //   %C = type { i8* }               %B.3 = type { %C.1 }
1186     //
1187     // When we link Module B with Module A, the '%B' in Module B is
1188     // used. However, that would then use '%C.1'. But when we process '%C.1',
1189     // we prefer to take the '%C' version. So we are then left with both
1190     // '%C.1' and '%C' being used for the same types. This leads to some
1191     // variables using one type and some using the other.
1192     if (TypeMap.DstStructTypesSet.hasType(DST))
1193       TypeMap.addTypeMapping(DST, ST);
1194   }
1195
1196   // Now that we have discovered all of the type equivalences, get a body for
1197   // any 'opaque' types in the dest module that are now resolved.
1198   TypeMap.linkDefinedTypeBodies();
1199 }
1200
1201 static void upgradeGlobalArray(GlobalVariable *GV) {
1202   ArrayType *ATy = cast<ArrayType>(GV->getType()->getElementType());
1203   StructType *OldTy = cast<StructType>(ATy->getElementType());
1204   assert(OldTy->getNumElements() == 2 && "Expected to upgrade from 2 elements");
1205
1206   // Get the upgraded 3 element type.
1207   PointerType *VoidPtrTy = Type::getInt8Ty(GV->getContext())->getPointerTo();
1208   Type *Tys[3] = {OldTy->getElementType(0), OldTy->getElementType(1),
1209                   VoidPtrTy};
1210   StructType *NewTy = StructType::get(GV->getContext(), Tys, false);
1211
1212   // Build new constants with a null third field filled in.
1213   Constant *OldInitC = GV->getInitializer();
1214   ConstantArray *OldInit = dyn_cast<ConstantArray>(OldInitC);
1215   if (!OldInit && !isa<ConstantAggregateZero>(OldInitC))
1216     // Invalid initializer; give up.
1217     return;
1218   std::vector<Constant *> Initializers;
1219   if (OldInit && OldInit->getNumOperands()) {
1220     Value *Null = Constant::getNullValue(VoidPtrTy);
1221     for (Use &U : OldInit->operands()) {
1222       ConstantStruct *Init = cast<ConstantStruct>(U.get());
1223       Initializers.push_back(ConstantStruct::get(
1224           NewTy, Init->getOperand(0), Init->getOperand(1), Null, nullptr));
1225     }
1226   }
1227   assert(Initializers.size() == ATy->getNumElements() &&
1228          "Failed to copy all array elements");
1229
1230   // Replace the old GV with a new one.
1231   ATy = ArrayType::get(NewTy, Initializers.size());
1232   Constant *NewInit = ConstantArray::get(ATy, Initializers);
1233   GlobalVariable *NewGV = new GlobalVariable(
1234       *GV->getParent(), ATy, GV->isConstant(), GV->getLinkage(), NewInit, "",
1235       GV, GV->getThreadLocalMode(), GV->getType()->getAddressSpace(),
1236       GV->isExternallyInitialized());
1237   NewGV->copyAttributesFrom(GV);
1238   NewGV->takeName(GV);
1239   assert(GV->use_empty() && "program cannot use initializer list");
1240   GV->eraseFromParent();
1241 }
1242
1243 void ModuleLinker::upgradeMismatchedGlobalArray(StringRef Name) {
1244   // Look for the global arrays.
1245   auto *DstGV = dyn_cast_or_null<GlobalVariable>(DstM->getNamedValue(Name));
1246   if (!DstGV)
1247     return;
1248   auto *SrcGV = dyn_cast_or_null<GlobalVariable>(SrcM->getNamedValue(Name));
1249   if (!SrcGV)
1250     return;
1251
1252   // Check if the types already match.
1253   auto *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
1254   auto *SrcTy =
1255       cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
1256   if (DstTy == SrcTy)
1257     return;
1258
1259   // Grab the element types.  We can only upgrade an array of a two-field
1260   // struct.  Only bother if the other one has three-fields.
1261   auto *DstEltTy = cast<StructType>(DstTy->getElementType());
1262   auto *SrcEltTy = cast<StructType>(SrcTy->getElementType());
1263   if (DstEltTy->getNumElements() == 2 && SrcEltTy->getNumElements() == 3) {
1264     upgradeGlobalArray(DstGV);
1265     return;
1266   }
1267   if (DstEltTy->getNumElements() == 3 && SrcEltTy->getNumElements() == 2)
1268     upgradeGlobalArray(SrcGV);
1269
1270   // We can't upgrade any other differences.
1271 }
1272
1273 void ModuleLinker::upgradeMismatchedGlobals() {
1274   upgradeMismatchedGlobalArray("llvm.global_ctors");
1275   upgradeMismatchedGlobalArray("llvm.global_dtors");
1276 }
1277
1278 /// If there were any appending global variables, link them together now.
1279 /// Return true on error.
1280 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
1281                                          const GlobalVariable *SrcGV) {
1282
1283   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
1284     return emitError("Linking globals named '" + SrcGV->getName() +
1285            "': can only link appending global with another appending global!");
1286
1287   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
1288   ArrayType *SrcTy =
1289     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
1290   Type *EltTy = DstTy->getElementType();
1291
1292   // Check to see that they two arrays agree on type.
1293   if (EltTy != SrcTy->getElementType())
1294     return emitError("Appending variables with different element types!");
1295   if (DstGV->isConstant() != SrcGV->isConstant())
1296     return emitError("Appending variables linked with different const'ness!");
1297
1298   if (DstGV->getAlignment() != SrcGV->getAlignment())
1299     return emitError(
1300              "Appending variables with different alignment need to be linked!");
1301
1302   if (DstGV->getVisibility() != SrcGV->getVisibility())
1303     return emitError(
1304             "Appending variables with different visibility need to be linked!");
1305
1306   if (DstGV->hasUnnamedAddr() != SrcGV->hasUnnamedAddr())
1307     return emitError(
1308         "Appending variables with different unnamed_addr need to be linked!");
1309
1310   if (StringRef(DstGV->getSection()) != SrcGV->getSection())
1311     return emitError(
1312           "Appending variables with different section name need to be linked!");
1313
1314   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
1315   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
1316
1317   // Create the new global variable.
1318   GlobalVariable *NG =
1319     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
1320                        DstGV->getLinkage(), /*init*/nullptr, /*name*/"", DstGV,
1321                        DstGV->getThreadLocalMode(),
1322                        DstGV->getType()->getAddressSpace());
1323
1324   // Propagate alignment, visibility and section info.
1325   copyGVAttributes(NG, DstGV);
1326
1327   AppendingVarInfo AVI;
1328   AVI.NewGV = NG;
1329   AVI.DstInit = DstGV->getInitializer();
1330   AVI.SrcInit = SrcGV->getInitializer();
1331   AppendingVars.push_back(AVI);
1332
1333   // Replace any uses of the two global variables with uses of the new
1334   // global.
1335   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
1336
1337   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
1338   DstGV->eraseFromParent();
1339
1340   // Track the source variable so we don't try to link it.
1341   DoNotLinkFromSource.insert(SrcGV);
1342
1343   return false;
1344 }
1345
1346 bool ModuleLinker::linkGlobalValueProto(GlobalValue *SGV) {
1347   GlobalValue *DGV = getLinkedToGlobal(SGV);
1348
1349   // Handle the ultra special appending linkage case first.
1350   assert(!DGV || SGV->hasAppendingLinkage() == DGV->hasAppendingLinkage());
1351   if (SGV->hasAppendingLinkage() && isPerformingImport()) {
1352     // Don't want to append to global_ctors list, for example, when we
1353     // are importing for ThinLTO, otherwise the global ctors and dtors
1354     // get executed multiple times for local variables (the latter causing
1355     // double frees).
1356     DoNotLinkFromSource.insert(SGV);
1357     return false;
1358   }
1359   if (DGV && DGV->hasAppendingLinkage())
1360     return linkAppendingVarProto(cast<GlobalVariable>(DGV),
1361                                  cast<GlobalVariable>(SGV));
1362
1363   bool LinkFromSrc = true;
1364   Comdat *C = nullptr;
1365   bool HasUnnamedAddr = SGV->hasUnnamedAddr();
1366
1367   if (const Comdat *SC = SGV->getComdat()) {
1368     Comdat::SelectionKind SK;
1369     std::tie(SK, LinkFromSrc) = ComdatsChosen[SC];
1370     C = DstM->getOrInsertComdat(SC->getName());
1371     C->setSelectionKind(SK);
1372   } else if (DGV) {
1373     if (shouldLinkFromSource(LinkFromSrc, *DGV, *SGV))
1374       return true;
1375   }
1376
1377   if (!LinkFromSrc) {
1378     // Track the source global so that we don't attempt to copy it over when
1379     // processing global initializers.
1380     DoNotLinkFromSource.insert(SGV);
1381
1382     if (DGV)
1383       // Make sure to remember this mapping.
1384       ValueMap[SGV] =
1385           ConstantExpr::getBitCast(DGV, TypeMap.get(SGV->getType()));
1386   }
1387
1388   if (DGV)
1389     HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr();
1390
1391   if (!LinkFromSrc && !DGV)
1392     return false;
1393
1394   GlobalValue *NewGV;
1395   if (!LinkFromSrc) {
1396     NewGV = DGV;
1397     // When linking from source we setVisibility from copyGlobalValueProto.
1398     setVisibility(NewGV, SGV, DGV);
1399   } else {
1400     // If the GV is to be lazily linked, don't create it just yet.
1401     // The ValueMaterializerTy will deal with creating it if it's used.
1402     if (!DGV && !shouldOverrideFromSrc() && SGV != ImportFunction &&
1403         (SGV->hasLocalLinkage() || SGV->hasLinkOnceLinkage() ||
1404          SGV->hasAvailableExternallyLinkage())) {
1405       DoNotLinkFromSource.insert(SGV);
1406       return false;
1407     }
1408
1409     // When we only want to link in unresolved dependencies, blacklist
1410     // the symbol unless unless DestM has a matching declaration (DGV).
1411     if (shouldLinkOnlyNeeded() && !(DGV && DGV->isDeclaration())) {
1412       DoNotLinkFromSource.insert(SGV);
1413       return false;
1414     }
1415
1416     NewGV = copyGlobalValueProto(TypeMap, SGV, DGV);
1417
1418     if (DGV && isa<Function>(DGV))
1419       if (auto *NewF = dyn_cast<Function>(NewGV))
1420         OverridingFunctions.insert(NewF);
1421   }
1422
1423   NewGV->setUnnamedAddr(HasUnnamedAddr);
1424
1425   if (auto *NewGO = dyn_cast<GlobalObject>(NewGV)) {
1426     if (C)
1427       NewGO->setComdat(C);
1428
1429     if (DGV && DGV->hasCommonLinkage() && SGV->hasCommonLinkage())
1430       NewGO->setAlignment(std::max(DGV->getAlignment(), SGV->getAlignment()));
1431   }
1432
1433   if (auto *NewGVar = dyn_cast<GlobalVariable>(NewGV)) {
1434     auto *DGVar = dyn_cast_or_null<GlobalVariable>(DGV);
1435     auto *SGVar = dyn_cast<GlobalVariable>(SGV);
1436     if (DGVar && SGVar && DGVar->isDeclaration() && SGVar->isDeclaration() &&
1437         (!DGVar->isConstant() || !SGVar->isConstant()))
1438       NewGVar->setConstant(false);
1439   }
1440
1441   // Make sure to remember this mapping.
1442   if (NewGV != DGV) {
1443     if (DGV) {
1444       DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewGV, DGV->getType()));
1445       DGV->eraseFromParent();
1446     }
1447     ValueMap[SGV] = NewGV;
1448   }
1449
1450   return false;
1451 }
1452
1453 static void getArrayElements(const Constant *C,
1454                              SmallVectorImpl<Constant *> &Dest) {
1455   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
1456
1457   for (unsigned i = 0; i != NumElements; ++i)
1458     Dest.push_back(C->getAggregateElement(i));
1459 }
1460
1461 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
1462   // Merge the initializer.
1463   SmallVector<Constant *, 16> DstElements;
1464   getArrayElements(AVI.DstInit, DstElements);
1465
1466   SmallVector<Constant *, 16> SrcElements;
1467   getArrayElements(AVI.SrcInit, SrcElements);
1468
1469   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
1470
1471   StringRef Name = AVI.NewGV->getName();
1472   bool IsNewStructor =
1473       (Name == "llvm.global_ctors" || Name == "llvm.global_dtors") &&
1474       cast<StructType>(NewType->getElementType())->getNumElements() == 3;
1475
1476   for (auto *V : SrcElements) {
1477     if (IsNewStructor) {
1478       Constant *Key = V->getAggregateElement(2);
1479       if (DoNotLinkFromSource.count(Key))
1480         continue;
1481     }
1482     DstElements.push_back(
1483         MapValue(V, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1484   }
1485   if (IsNewStructor) {
1486     NewType = ArrayType::get(NewType->getElementType(), DstElements.size());
1487     AVI.NewGV->mutateType(PointerType::get(NewType, 0));
1488   }
1489
1490   AVI.NewGV->setInitializer(ConstantArray::get(NewType, DstElements));
1491 }
1492
1493 /// Update the initializers in the Dest module now that all globals that may be
1494 /// referenced are in Dest.
1495 void ModuleLinker::linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src) {
1496   // Figure out what the initializer looks like in the dest module.
1497   Dst.setInitializer(MapValue(Src.getInitializer(), ValueMap,
1498                               RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1499 }
1500
1501 /// Copy the source function over into the dest function and fix up references
1502 /// to values. At this point we know that Dest is an external function, and
1503 /// that Src is not.
1504 bool ModuleLinker::linkFunctionBody(Function &Dst, Function &Src) {
1505   assert(Dst.isDeclaration() && !Src.isDeclaration());
1506
1507   // Materialize if needed.
1508   if (std::error_code EC = Src.materialize())
1509     return emitError(EC.message());
1510
1511   // Link in the prefix data.
1512   if (Src.hasPrefixData())
1513     Dst.setPrefixData(MapValue(Src.getPrefixData(), ValueMap,
1514                                RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1515
1516   // Link in the prologue data.
1517   if (Src.hasPrologueData())
1518     Dst.setPrologueData(MapValue(Src.getPrologueData(), ValueMap,
1519                                  RF_MoveDistinctMDs, &TypeMap,
1520                                  &ValMaterializer));
1521
1522   // Link in the personality function.
1523   if (Src.hasPersonalityFn())
1524     Dst.setPersonalityFn(MapValue(Src.getPersonalityFn(), ValueMap,
1525                                   RF_MoveDistinctMDs, &TypeMap,
1526                                   &ValMaterializer));
1527
1528   // Go through and convert function arguments over, remembering the mapping.
1529   Function::arg_iterator DI = Dst.arg_begin();
1530   for (Argument &Arg : Src.args()) {
1531     DI->setName(Arg.getName());  // Copy the name over.
1532
1533     // Add a mapping to our mapping.
1534     ValueMap[&Arg] = &*DI;
1535     ++DI;
1536   }
1537
1538   // Copy over the metadata attachments.
1539   SmallVector<std::pair<unsigned, MDNode *>, 8> MDs;
1540   Src.getAllMetadata(MDs);
1541   for (const auto &I : MDs)
1542     Dst.setMetadata(I.first, MapMetadata(I.second, ValueMap, RF_MoveDistinctMDs,
1543                                          &TypeMap, &ValMaterializer));
1544
1545   // Splice the body of the source function into the dest function.
1546   Dst.getBasicBlockList().splice(Dst.end(), Src.getBasicBlockList());
1547
1548   // At this point, all of the instructions and values of the function are now
1549   // copied over.  The only problem is that they are still referencing values in
1550   // the Source function as operands.  Loop through all of the operands of the
1551   // functions and patch them up to point to the local versions.
1552   for (BasicBlock &BB : Dst)
1553     for (Instruction &I : BB)
1554       RemapInstruction(&I, ValueMap,
1555                        RF_IgnoreMissingEntries | RF_MoveDistinctMDs, &TypeMap,
1556                        &ValMaterializer);
1557
1558   // There is no need to map the arguments anymore.
1559   for (Argument &Arg : Src.args())
1560     ValueMap.erase(&Arg);
1561
1562   Src.dematerialize();
1563   return false;
1564 }
1565
1566 void ModuleLinker::linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src) {
1567   Constant *Aliasee = Src.getAliasee();
1568   Constant *Val = MapValue(Aliasee, ValueMap, RF_MoveDistinctMDs, &TypeMap,
1569                            &ValMaterializer);
1570   Dst.setAliasee(Val);
1571 }
1572
1573 bool ModuleLinker::linkGlobalValueBody(GlobalValue &Src) {
1574   Value *Dst = ValueMap[&Src];
1575   assert(Dst);
1576   if (shouldInternalizeLinkedSymbols())
1577     if (auto *DGV = dyn_cast<GlobalValue>(Dst))
1578       DGV->setLinkage(GlobalValue::InternalLinkage);
1579   if (auto *F = dyn_cast<Function>(&Src))
1580     return linkFunctionBody(cast<Function>(*Dst), *F);
1581   if (auto *GVar = dyn_cast<GlobalVariable>(&Src)) {
1582     linkGlobalInit(cast<GlobalVariable>(*Dst), *GVar);
1583     return false;
1584   }
1585   linkAliasBody(cast<GlobalAlias>(*Dst), cast<GlobalAlias>(Src));
1586   return false;
1587 }
1588
1589 /// Insert all of the named MDNodes in Src into the Dest module.
1590 void ModuleLinker::linkNamedMDNodes() {
1591   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1592   for (const NamedMDNode &NMD : SrcM->named_metadata()) {
1593     // Don't link module flags here. Do them separately.
1594     if (&NMD == SrcModFlags)
1595       continue;
1596     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(NMD.getName());
1597     // Add Src elements into Dest node.
1598     for (const MDNode *op : NMD.operands())
1599       DestNMD->addOperand(MapMetadata(op, ValueMap, RF_MoveDistinctMDs,
1600                                       &TypeMap, &ValMaterializer));
1601   }
1602 }
1603
1604 /// Drop DISubprograms that have been superseded.
1605 ///
1606 /// FIXME: this creates an asymmetric result: we strip functions from losing
1607 /// subprograms in DstM, but leave losing subprograms in SrcM.
1608 /// TODO: Remove this logic once the backend can correctly determine canonical
1609 /// subprograms.
1610 void ModuleLinker::stripReplacedSubprograms() {
1611   // Avoid quadratic runtime by returning early when there's nothing to do.
1612   if (OverridingFunctions.empty())
1613     return;
1614
1615   // Move the functions now, so the set gets cleared even on early returns.
1616   auto Functions = std::move(OverridingFunctions);
1617   OverridingFunctions.clear();
1618
1619   // Drop functions from subprograms if they've been overridden by the new
1620   // compile unit.
1621   NamedMDNode *CompileUnits = DstM->getNamedMetadata("llvm.dbg.cu");
1622   if (!CompileUnits)
1623     return;
1624   for (unsigned I = 0, E = CompileUnits->getNumOperands(); I != E; ++I) {
1625     auto *CU = cast<DICompileUnit>(CompileUnits->getOperand(I));
1626     assert(CU && "Expected valid compile unit");
1627
1628     for (DISubprogram *SP : CU->getSubprograms()) {
1629       if (!SP || !SP->getFunction() || !Functions.count(SP->getFunction()))
1630         continue;
1631
1632       // Prevent DebugInfoFinder from tagging this as the canonical subprogram,
1633       // since the canonical one is in the incoming module.
1634       SP->replaceFunction(nullptr);
1635     }
1636   }
1637 }
1638
1639 /// Merge the linker flags in Src into the Dest module.
1640 bool ModuleLinker::linkModuleFlagsMetadata() {
1641   // If the source module has no module flags, we are done.
1642   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1643   if (!SrcModFlags) return false;
1644
1645   // If the destination module doesn't have module flags yet, then just copy
1646   // over the source module's flags.
1647   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
1648   if (DstModFlags->getNumOperands() == 0) {
1649     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
1650       DstModFlags->addOperand(SrcModFlags->getOperand(I));
1651
1652     return false;
1653   }
1654
1655   // First build a map of the existing module flags and requirements.
1656   DenseMap<MDString *, std::pair<MDNode *, unsigned>> Flags;
1657   SmallSetVector<MDNode*, 16> Requirements;
1658   for (unsigned I = 0, E = DstModFlags->getNumOperands(); I != E; ++I) {
1659     MDNode *Op = DstModFlags->getOperand(I);
1660     ConstantInt *Behavior = mdconst::extract<ConstantInt>(Op->getOperand(0));
1661     MDString *ID = cast<MDString>(Op->getOperand(1));
1662
1663     if (Behavior->getZExtValue() == Module::Require) {
1664       Requirements.insert(cast<MDNode>(Op->getOperand(2)));
1665     } else {
1666       Flags[ID] = std::make_pair(Op, I);
1667     }
1668   }
1669
1670   // Merge in the flags from the source module, and also collect its set of
1671   // requirements.
1672   bool HasErr = false;
1673   for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) {
1674     MDNode *SrcOp = SrcModFlags->getOperand(I);
1675     ConstantInt *SrcBehavior =
1676         mdconst::extract<ConstantInt>(SrcOp->getOperand(0));
1677     MDString *ID = cast<MDString>(SrcOp->getOperand(1));
1678     MDNode *DstOp;
1679     unsigned DstIndex;
1680     std::tie(DstOp, DstIndex) = Flags.lookup(ID);
1681     unsigned SrcBehaviorValue = SrcBehavior->getZExtValue();
1682
1683     // If this is a requirement, add it and continue.
1684     if (SrcBehaviorValue == Module::Require) {
1685       // If the destination module does not already have this requirement, add
1686       // it.
1687       if (Requirements.insert(cast<MDNode>(SrcOp->getOperand(2)))) {
1688         DstModFlags->addOperand(SrcOp);
1689       }
1690       continue;
1691     }
1692
1693     // If there is no existing flag with this ID, just add it.
1694     if (!DstOp) {
1695       Flags[ID] = std::make_pair(SrcOp, DstModFlags->getNumOperands());
1696       DstModFlags->addOperand(SrcOp);
1697       continue;
1698     }
1699
1700     // Otherwise, perform a merge.
1701     ConstantInt *DstBehavior =
1702         mdconst::extract<ConstantInt>(DstOp->getOperand(0));
1703     unsigned DstBehaviorValue = DstBehavior->getZExtValue();
1704
1705     // If either flag has override behavior, handle it first.
1706     if (DstBehaviorValue == Module::Override) {
1707       // Diagnose inconsistent flags which both have override behavior.
1708       if (SrcBehaviorValue == Module::Override &&
1709           SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1710         HasErr |= emitError("linking module flags '" + ID->getString() +
1711                             "': IDs have conflicting override values");
1712       }
1713       continue;
1714     } else if (SrcBehaviorValue == Module::Override) {
1715       // Update the destination flag to that of the source.
1716       DstModFlags->setOperand(DstIndex, SrcOp);
1717       Flags[ID].first = SrcOp;
1718       continue;
1719     }
1720
1721     // Diagnose inconsistent merge behavior types.
1722     if (SrcBehaviorValue != DstBehaviorValue) {
1723       HasErr |= emitError("linking module flags '" + ID->getString() +
1724                           "': IDs have conflicting behaviors");
1725       continue;
1726     }
1727
1728     auto replaceDstValue = [&](MDNode *New) {
1729       Metadata *FlagOps[] = {DstOp->getOperand(0), ID, New};
1730       MDNode *Flag = MDNode::get(DstM->getContext(), FlagOps);
1731       DstModFlags->setOperand(DstIndex, Flag);
1732       Flags[ID].first = Flag;
1733     };
1734
1735     // Perform the merge for standard behavior types.
1736     switch (SrcBehaviorValue) {
1737     case Module::Require:
1738     case Module::Override: llvm_unreachable("not possible");
1739     case Module::Error: {
1740       // Emit an error if the values differ.
1741       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1742         HasErr |= emitError("linking module flags '" + ID->getString() +
1743                             "': IDs have conflicting values");
1744       }
1745       continue;
1746     }
1747     case Module::Warning: {
1748       // Emit a warning if the values differ.
1749       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1750         emitWarning("linking module flags '" + ID->getString() +
1751                     "': IDs have conflicting values");
1752       }
1753       continue;
1754     }
1755     case Module::Append: {
1756       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1757       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1758       SmallVector<Metadata *, 8> MDs;
1759       MDs.reserve(DstValue->getNumOperands() + SrcValue->getNumOperands());
1760       MDs.append(DstValue->op_begin(), DstValue->op_end());
1761       MDs.append(SrcValue->op_begin(), SrcValue->op_end());
1762
1763       replaceDstValue(MDNode::get(DstM->getContext(), MDs));
1764       break;
1765     }
1766     case Module::AppendUnique: {
1767       SmallSetVector<Metadata *, 16> Elts;
1768       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1769       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1770       Elts.insert(DstValue->op_begin(), DstValue->op_end());
1771       Elts.insert(SrcValue->op_begin(), SrcValue->op_end());
1772
1773       replaceDstValue(MDNode::get(DstM->getContext(),
1774                                   makeArrayRef(Elts.begin(), Elts.end())));
1775       break;
1776     }
1777     }
1778   }
1779
1780   // Check all of the requirements.
1781   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1782     MDNode *Requirement = Requirements[I];
1783     MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1784     Metadata *ReqValue = Requirement->getOperand(1);
1785
1786     MDNode *Op = Flags[Flag].first;
1787     if (!Op || Op->getOperand(2) != ReqValue) {
1788       HasErr |= emitError("linking module flags '" + Flag->getString() +
1789                           "': does not have the required value");
1790       continue;
1791     }
1792   }
1793
1794   return HasErr;
1795 }
1796
1797 // This function returns true if the triples match.
1798 static bool triplesMatch(const Triple &T0, const Triple &T1) {
1799   // If vendor is apple, ignore the version number.
1800   if (T0.getVendor() == Triple::Apple)
1801     return T0.getArch() == T1.getArch() &&
1802            T0.getSubArch() == T1.getSubArch() &&
1803            T0.getVendor() == T1.getVendor() &&
1804            T0.getOS() == T1.getOS();
1805
1806   return T0 == T1;
1807 }
1808
1809 // This function returns the merged triple.
1810 static std::string mergeTriples(const Triple &SrcTriple, const Triple &DstTriple) {
1811   // If vendor is apple, pick the triple with the larger version number.
1812   if (SrcTriple.getVendor() == Triple::Apple)
1813     if (DstTriple.isOSVersionLT(SrcTriple))
1814       return SrcTriple.str();
1815
1816   return DstTriple.str();
1817 }
1818
1819 bool ModuleLinker::run() {
1820   assert(DstM && "Null destination module");
1821   assert(SrcM && "Null source module");
1822
1823   // Inherit the target data from the source module if the destination module
1824   // doesn't have one already.
1825   if (DstM->getDataLayout().isDefault())
1826     DstM->setDataLayout(SrcM->getDataLayout());
1827
1828   if (SrcM->getDataLayout() != DstM->getDataLayout()) {
1829     emitWarning("Linking two modules of different data layouts: '" +
1830                 SrcM->getModuleIdentifier() + "' is '" +
1831                 SrcM->getDataLayoutStr() + "' whereas '" +
1832                 DstM->getModuleIdentifier() + "' is '" +
1833                 DstM->getDataLayoutStr() + "'\n");
1834   }
1835
1836   // Copy the target triple from the source to dest if the dest's is empty.
1837   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1838     DstM->setTargetTriple(SrcM->getTargetTriple());
1839
1840   Triple SrcTriple(SrcM->getTargetTriple()), DstTriple(DstM->getTargetTriple());
1841
1842   if (!SrcM->getTargetTriple().empty() && !triplesMatch(SrcTriple, DstTriple))
1843     emitWarning("Linking two modules of different target triples: " +
1844                 SrcM->getModuleIdentifier() + "' is '" +
1845                 SrcM->getTargetTriple() + "' whereas '" +
1846                 DstM->getModuleIdentifier() + "' is '" +
1847                 DstM->getTargetTriple() + "'\n");
1848
1849   DstM->setTargetTriple(mergeTriples(SrcTriple, DstTriple));
1850
1851   // Append the module inline asm string.
1852   if (!SrcM->getModuleInlineAsm().empty()) {
1853     if (DstM->getModuleInlineAsm().empty())
1854       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1855     else
1856       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1857                                SrcM->getModuleInlineAsm());
1858   }
1859
1860   // Loop over all of the linked values to compute type mappings.
1861   computeTypeMapping();
1862
1863   ComdatsChosen.clear();
1864   for (const auto &SMEC : SrcM->getComdatSymbolTable()) {
1865     const Comdat &C = SMEC.getValue();
1866     if (ComdatsChosen.count(&C))
1867       continue;
1868     Comdat::SelectionKind SK;
1869     bool LinkFromSrc;
1870     if (getComdatResult(&C, SK, LinkFromSrc))
1871       return true;
1872     ComdatsChosen[&C] = std::make_pair(SK, LinkFromSrc);
1873   }
1874
1875   // Upgrade mismatched global arrays.
1876   upgradeMismatchedGlobals();
1877
1878   // Insert all of the globals in src into the DstM module... without linking
1879   // initializers (which could refer to functions not yet mapped over).
1880   for (GlobalVariable &GV : SrcM->globals())
1881     if (linkGlobalValueProto(&GV))
1882       return true;
1883
1884   // Link the functions together between the two modules, without doing function
1885   // bodies... this just adds external function prototypes to the DstM
1886   // function...  We do this so that when we begin processing function bodies,
1887   // all of the global values that may be referenced are available in our
1888   // ValueMap.
1889   for (Function &F :*SrcM)
1890     if (linkGlobalValueProto(&F))
1891       return true;
1892
1893   // If there were any aliases, link them now.
1894   for (GlobalAlias &GA : SrcM->aliases())
1895     if (linkGlobalValueProto(&GA))
1896       return true;
1897
1898   for (const AppendingVarInfo &AppendingVar : AppendingVars)
1899     linkAppendingVarInit(AppendingVar);
1900
1901   for (const auto &Entry : DstM->getComdatSymbolTable()) {
1902     const Comdat &C = Entry.getValue();
1903     if (C.getSelectionKind() == Comdat::Any)
1904       continue;
1905     const GlobalValue *GV = SrcM->getNamedValue(C.getName());
1906     if (GV)
1907       MapValue(GV, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer);
1908   }
1909
1910   // Strip replaced subprograms before mapping any metadata -- so that we're
1911   // not changing metadata from the source module (note that
1912   // linkGlobalValueBody() eventually calls RemapInstruction() and therefore
1913   // MapMetadata()) -- but after linking global value protocols -- so that
1914   // OverridingFunctions has been built.
1915   stripReplacedSubprograms();
1916
1917   // Link in the function bodies that are defined in the source module into
1918   // DstM.
1919   for (Function &SF : *SrcM) {
1920     // Skip if no body (function is external).
1921     if (SF.isDeclaration())
1922       continue;
1923
1924     // Skip if not linking from source.
1925     if (DoNotLinkFromSource.count(&SF))
1926       continue;
1927
1928     // When importing, only materialize the function requested for import.
1929     if (isPerformingImport() && &SF != ImportFunction)
1930       continue;
1931
1932     if (linkGlobalValueBody(SF))
1933       return true;
1934   }
1935
1936   // Resolve all uses of aliases with aliasees.
1937   for (GlobalAlias &Src : SrcM->aliases()) {
1938     if (DoNotLinkFromSource.count(&Src))
1939       continue;
1940     linkGlobalValueBody(Src);
1941   }
1942
1943   // Remap all of the named MDNodes in Src into the DstM module. We do this
1944   // after linking GlobalValues so that MDNodes that reference GlobalValues
1945   // are properly remapped.
1946   linkNamedMDNodes();
1947
1948   // Merge the module flags into the DstM module.
1949   if (linkModuleFlagsMetadata())
1950     return true;
1951
1952   // Update the initializers in the DstM module now that all globals that may
1953   // be referenced are in DstM.
1954   for (GlobalVariable &Src : SrcM->globals()) {
1955     // Only process initialized GV's or ones not already in dest.
1956     if (!Src.hasInitializer() || DoNotLinkFromSource.count(&Src))
1957       continue;
1958     linkGlobalValueBody(Src);
1959   }
1960
1961   // Process vector of lazily linked in functions.
1962   while (!LazilyLinkGlobalValues.empty()) {
1963     GlobalValue *SGV = LazilyLinkGlobalValues.back();
1964     LazilyLinkGlobalValues.pop_back();
1965     if (isPerformingImport() && !doImportAsDefinition(SGV))
1966       continue;
1967
1968     // Skip declarations that ValueMaterializer may have created in
1969     // case we link in only some of SrcM.
1970     if (shouldLinkOnlyNeeded() && SGV->isDeclaration())
1971       continue;
1972
1973     assert(!SGV->isDeclaration() && "users should not pass down decls");
1974     if (linkGlobalValueBody(*SGV))
1975       return true;
1976   }
1977
1978   return false;
1979 }
1980
1981 Linker::StructTypeKeyInfo::KeyTy::KeyTy(ArrayRef<Type *> E, bool P)
1982     : ETypes(E), IsPacked(P) {}
1983
1984 Linker::StructTypeKeyInfo::KeyTy::KeyTy(const StructType *ST)
1985     : ETypes(ST->elements()), IsPacked(ST->isPacked()) {}
1986
1987 bool Linker::StructTypeKeyInfo::KeyTy::operator==(const KeyTy &That) const {
1988   if (IsPacked != That.IsPacked)
1989     return false;
1990   if (ETypes != That.ETypes)
1991     return false;
1992   return true;
1993 }
1994
1995 bool Linker::StructTypeKeyInfo::KeyTy::operator!=(const KeyTy &That) const {
1996   return !this->operator==(That);
1997 }
1998
1999 StructType *Linker::StructTypeKeyInfo::getEmptyKey() {
2000   return DenseMapInfo<StructType *>::getEmptyKey();
2001 }
2002
2003 StructType *Linker::StructTypeKeyInfo::getTombstoneKey() {
2004   return DenseMapInfo<StructType *>::getTombstoneKey();
2005 }
2006
2007 unsigned Linker::StructTypeKeyInfo::getHashValue(const KeyTy &Key) {
2008   return hash_combine(hash_combine_range(Key.ETypes.begin(), Key.ETypes.end()),
2009                       Key.IsPacked);
2010 }
2011
2012 unsigned Linker::StructTypeKeyInfo::getHashValue(const StructType *ST) {
2013   return getHashValue(KeyTy(ST));
2014 }
2015
2016 bool Linker::StructTypeKeyInfo::isEqual(const KeyTy &LHS,
2017                                         const StructType *RHS) {
2018   if (RHS == getEmptyKey() || RHS == getTombstoneKey())
2019     return false;
2020   return LHS == KeyTy(RHS);
2021 }
2022
2023 bool Linker::StructTypeKeyInfo::isEqual(const StructType *LHS,
2024                                         const StructType *RHS) {
2025   if (RHS == getEmptyKey())
2026     return LHS == getEmptyKey();
2027
2028   if (RHS == getTombstoneKey())
2029     return LHS == getTombstoneKey();
2030
2031   return KeyTy(LHS) == KeyTy(RHS);
2032 }
2033
2034 void Linker::IdentifiedStructTypeSet::addNonOpaque(StructType *Ty) {
2035   assert(!Ty->isOpaque());
2036   NonOpaqueStructTypes.insert(Ty);
2037 }
2038
2039 void Linker::IdentifiedStructTypeSet::switchToNonOpaque(StructType *Ty) {
2040   assert(!Ty->isOpaque());
2041   NonOpaqueStructTypes.insert(Ty);
2042   bool Removed = OpaqueStructTypes.erase(Ty);
2043   (void)Removed;
2044   assert(Removed);
2045 }
2046
2047 void Linker::IdentifiedStructTypeSet::addOpaque(StructType *Ty) {
2048   assert(Ty->isOpaque());
2049   OpaqueStructTypes.insert(Ty);
2050 }
2051
2052 StructType *
2053 Linker::IdentifiedStructTypeSet::findNonOpaque(ArrayRef<Type *> ETypes,
2054                                                bool IsPacked) {
2055   Linker::StructTypeKeyInfo::KeyTy Key(ETypes, IsPacked);
2056   auto I = NonOpaqueStructTypes.find_as(Key);
2057   if (I == NonOpaqueStructTypes.end())
2058     return nullptr;
2059   return *I;
2060 }
2061
2062 bool Linker::IdentifiedStructTypeSet::hasType(StructType *Ty) {
2063   if (Ty->isOpaque())
2064     return OpaqueStructTypes.count(Ty);
2065   auto I = NonOpaqueStructTypes.find(Ty);
2066   if (I == NonOpaqueStructTypes.end())
2067     return false;
2068   return *I == Ty;
2069 }
2070
2071 void Linker::init(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
2072   this->Composite = M;
2073   this->DiagnosticHandler = DiagnosticHandler;
2074
2075   TypeFinder StructTypes;
2076   StructTypes.run(*M, true);
2077   for (StructType *Ty : StructTypes) {
2078     if (Ty->isOpaque())
2079       IdentifiedStructTypes.addOpaque(Ty);
2080     else
2081       IdentifiedStructTypes.addNonOpaque(Ty);
2082   }
2083 }
2084
2085 Linker::Linker(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
2086   init(M, DiagnosticHandler);
2087 }
2088
2089 Linker::Linker(Module *M) {
2090   init(M, [this](const DiagnosticInfo &DI) {
2091     Composite->getContext().diagnose(DI);
2092   });
2093 }
2094
2095 void Linker::deleteModule() {
2096   delete Composite;
2097   Composite = nullptr;
2098 }
2099
2100 bool Linker::linkInModule(Module *Src, unsigned Flags, FunctionInfoIndex *Index,
2101                           Function *FuncToImport) {
2102   ModuleLinker TheLinker(Composite, IdentifiedStructTypes, Src,
2103                          DiagnosticHandler, Flags, Index, FuncToImport);
2104   bool RetCode = TheLinker.run();
2105   Composite->dropTriviallyDeadConstantArrays();
2106   return RetCode;
2107 }
2108
2109 void Linker::setModule(Module *Dst) {
2110   init(Dst, DiagnosticHandler);
2111 }
2112
2113 //===----------------------------------------------------------------------===//
2114 // LinkModules entrypoint.
2115 //===----------------------------------------------------------------------===//
2116
2117 /// This function links two modules together, with the resulting Dest module
2118 /// modified to be the composite of the two input modules. If an error occurs,
2119 /// true is returned and ErrorMsg (if not null) is set to indicate the problem.
2120 /// Upon failure, the Dest module could be in a modified state, and shouldn't be
2121 /// relied on to be consistent.
2122 bool Linker::LinkModules(Module *Dest, Module *Src,
2123                          DiagnosticHandlerFunction DiagnosticHandler,
2124                          unsigned Flags) {
2125   Linker L(Dest, DiagnosticHandler);
2126   return L.linkInModule(Src, Flags);
2127 }
2128
2129 bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Flags) {
2130   Linker L(Dest);
2131   return L.linkInModule(Src, Flags);
2132 }
2133
2134 //===----------------------------------------------------------------------===//
2135 // C API.
2136 //===----------------------------------------------------------------------===//
2137
2138 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
2139                          LLVMLinkerMode Unused, char **OutMessages) {
2140   Module *D = unwrap(Dest);
2141   std::string Message;
2142   raw_string_ostream Stream(Message);
2143   DiagnosticPrinterRawOStream DP(Stream);
2144
2145   LLVMBool Result = Linker::LinkModules(
2146       D, unwrap(Src), [&](const DiagnosticInfo &DI) { DI.print(DP); });
2147
2148   if (OutMessages && Result) {
2149     Stream.flush();
2150     *OutMessages = strdup(Message.c_str());
2151   }
2152   return Result;
2153 }