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