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 : public ValueMaterializer {
 369   TypeMapTy &TypeMap;
 370   Module *DstM;
 371   std::vector<GlobalValue *> &LazilyLinkGlobalValues;
 372
 373 public:
 374   ValueMaterializerTy(TypeMapTy &TypeMap, Module *DstM,
 375                       std::vector<GlobalValue *> &LazilyLinkGlobalValues)
 376       : ValueMaterializer(), TypeMap(TypeMap), DstM(DstM),
 377         LazilyLinkGlobalValues(LazilyLinkGlobalValues) {}
 378
 379   Value *materializeValueFor(Value *V) override;
 380 };
 381
 382 class LinkDiagnosticInfo : public DiagnosticInfo {
 383   const Twine &Msg;
 384
 385 public:
 386   LinkDiagnosticInfo(DiagnosticSeverity Severity, const Twine &Msg);
 387   void print(DiagnosticPrinter &DP) const override;
 388 };
 389 LinkDiagnosticInfo::LinkDiagnosticInfo(DiagnosticSeverity Severity,
 390                                        const Twine &Msg)
 391     : DiagnosticInfo(DK_Linker, Severity), Msg(Msg) {}
 392 void LinkDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
 393
 394 /// This is an implementation class for the LinkModules function, which is the
 395 /// entrypoint for this file.
 396 class ModuleLinker {
 397   Module *DstM, *SrcM;
 398
 399   TypeMapTy TypeMap;
 400   ValueMaterializerTy ValMaterializer;
 401
 402   /// Mapping of values from what they used to be in Src, to what they are now
 403   /// in DstM.  ValueToValueMapTy is a ValueMap, which involves some overhead
 404   /// due to the use of Value handles which the Linker doesn't actually need,
 405   /// but this allows us to reuse the ValueMapper code.
 406   ValueToValueMapTy ValueMap;
 407
 408   struct AppendingVarInfo {
 409     GlobalVariable *NewGV;   // New aggregate global in dest module.
 410     const Constant *DstInit; // Old initializer from dest module.
 411     const Constant *SrcInit; // Old initializer from src module.
 412   };
 413
 414   std::vector<AppendingVarInfo> AppendingVars;
 415
 416   // Set of items not to link in from source.
 417   SmallPtrSet<const Value *, 16> DoNotLinkFromSource;
 418
 419   // Vector of GlobalValues to lazily link in.
 420   std::vector<GlobalValue *> LazilyLinkGlobalValues;
 421
 422   /// Functions that have replaced other functions.
 423   SmallPtrSet<const Function *, 16> OverridingFunctions;
 424
 425   DiagnosticHandlerFunction DiagnosticHandler;
 426
 427   /// For symbol clashes, prefer those from Src.
 428   unsigned Flags;
 429
 430 public:
 431   ModuleLinker(Module *dstM, Linker::IdentifiedStructTypeSet &Set, Module *srcM,
 432                DiagnosticHandlerFunction DiagnosticHandler, unsigned Flags)
 433       : DstM(dstM), SrcM(srcM), TypeMap(Set),
 434         ValMaterializer(TypeMap, DstM, LazilyLinkGlobalValues),
 435         DiagnosticHandler(DiagnosticHandler), Flags(Flags) {}
 436
 437   bool run();
 438
 439   bool shouldOverrideFromSrc() { return Flags & Linker::OverrideFromSrc; }
 440   bool shouldLinkOnlyNeeded() { return Flags & Linker::LinkOnlyNeeded; }
 441   bool shouldInternalizeLinkedSymbols() {
 442     return Flags & Linker::InternalizeLinkedSymbols;
 443   }
 444
 445 private:
 446   bool shouldLinkFromSource(bool &LinkFromSrc, const GlobalValue &Dest,
 447                             const GlobalValue &Src);
 448
 449   /// Helper method for setting a message and returning an error code.
 450   bool emitError(const Twine &Message) {
 451     DiagnosticHandler(LinkDiagnosticInfo(DS_Error, Message));
 452     return true;
 453   }
 454
 455   void emitWarning(const Twine &Message) {
 456     DiagnosticHandler(LinkDiagnosticInfo(DS_Warning, Message));
 457   }
 458
 459   bool getComdatLeader(Module *M, StringRef ComdatName,
 460                        const GlobalVariable *&GVar);
 461   bool computeResultingSelectionKind(StringRef ComdatName,
 462                                      Comdat::SelectionKind Src,
 463                                      Comdat::SelectionKind Dst,
 464                                      Comdat::SelectionKind &Result,
 465                                      bool &LinkFromSrc);
 466   std::map<const Comdat *, std::pair<Comdat::SelectionKind, bool>>
 467       ComdatsChosen;
 468   bool getComdatResult(const Comdat *SrcC, Comdat::SelectionKind &SK,
 469                        bool &LinkFromSrc);
 470
 471   /// Given a global in the source module, return the global in the
 472   /// destination module that is being linked to, if any.
 473   GlobalValue *getLinkedToGlobal(const GlobalValue *SrcGV) {
 474     // If the source has no name it can't link.  If it has local linkage,
 475     // there is no name match-up going on.
 476     if (!SrcGV->hasName() || SrcGV->hasLocalLinkage())
 477       return nullptr;
 478
 479     // Otherwise see if we have a match in the destination module's symtab.
 480     GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName());
 481     if (!DGV)
 482       return nullptr;
 483
 484     // If we found a global with the same name in the dest module, but it has
 485     // internal linkage, we are really not doing any linkage here.
 486     if (DGV->hasLocalLinkage())
 487       return nullptr;
 488
 489     // Otherwise, we do in fact link to the destination global.
 490     return DGV;
 491   }
 492
 493   void computeTypeMapping();
 494
 495   void upgradeMismatchedGlobalArray(StringRef Name);
 496   void upgradeMismatchedGlobals();
 497
 498   bool linkAppendingVarProto(GlobalVariable *DstGV,
 499                              const GlobalVariable *SrcGV);
 500
 501   bool linkGlobalValueProto(GlobalValue *GV);
 502   bool linkModuleFlagsMetadata();
 503
 504   void linkAppendingVarInit(const AppendingVarInfo &AVI);
 505
 506   void linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src);
 507   bool linkFunctionBody(Function &Dst, Function &Src);
 508   void linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src);
 509   bool linkGlobalValueBody(GlobalValue &Src);
 510
 511   void linkNamedMDNodes();
 512   void stripReplacedSubprograms();
 513 };
 514 }
 515
 516 /// The LLVM SymbolTable class autorenames globals that conflict in the symbol
 517 /// table. This is good for all clients except for us. Go through the trouble
 518 /// to force this back.
 519 static void forceRenaming(GlobalValue *GV, StringRef Name) {
 520   // If the global doesn't force its name or if it already has the right name,
 521   // there is nothing for us to do.
 522   if (GV->hasLocalLinkage() || GV->getName() == Name)
 523     return;
 524
 525   Module *M = GV->getParent();
 526
 527   // If there is a conflict, rename the conflict.
 528   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
 529     GV->takeName(ConflictGV);
 530     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
 531     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
 532   } else {
 533     GV->setName(Name);              // Force the name back
 534   }
 535 }
 536
 537 /// copy additional attributes (those not needed to construct a GlobalValue)
 538 /// from the SrcGV to the DestGV.
 539 static void copyGVAttributes(GlobalValue *DestGV, const GlobalValue *SrcGV) {
 540   DestGV->copyAttributesFrom(SrcGV);
 541   forceRenaming(DestGV, SrcGV->getName());
 542 }
 543
 544 static bool isLessConstraining(GlobalValue::VisibilityTypes a,
 545                                GlobalValue::VisibilityTypes b) {
 546   if (a == GlobalValue::HiddenVisibility)
 547     return false;
 548   if (b == GlobalValue::HiddenVisibility)
 549     return true;
 550   if (a == GlobalValue::ProtectedVisibility)
 551     return false;
 552   if (b == GlobalValue::ProtectedVisibility)
 553     return true;
 554   return false;
 555 }
 556
 557 /// Loop through the global variables in the src module and merge them into the
 558 /// dest module.
 559 static GlobalVariable *copyGlobalVariableProto(TypeMapTy &TypeMap, Module &DstM,
 560                                                const GlobalVariable *SGVar) {
 561   // No linking to be performed or linking from the source: simply create an
 562   // identical version of the symbol over in the dest module... the
 563   // initializer will be filled in later by LinkGlobalInits.
 564   GlobalVariable *NewDGV = new GlobalVariable(
 565       DstM, TypeMap.get(SGVar->getType()->getElementType()),
 566       SGVar->isConstant(), SGVar->getLinkage(), /*init*/ nullptr,
 567       SGVar->getName(), /*insertbefore*/ nullptr, SGVar->getThreadLocalMode(),
 568       SGVar->getType()->getAddressSpace());
 569
 570   return NewDGV;
 571 }
 572
 573 /// Link the function in the source module into the destination module if
 574 /// needed, setting up mapping information.
 575 static Function *copyFunctionProto(TypeMapTy &TypeMap, Module &DstM,
 576                                    const Function *SF) {
 577   // If there is no linkage to be performed or we are linking from the source,
 578   // bring SF over.
 579   return Function::Create(TypeMap.get(SF->getFunctionType()), SF->getLinkage(),
 580                           SF->getName(), &DstM);
 581 }
 582
 583 /// Set up prototypes for any aliases that come over from the source module.
 584 static GlobalAlias *copyGlobalAliasProto(TypeMapTy &TypeMap, Module &DstM,
 585                                          const GlobalAlias *SGA) {
 586   // If there is no linkage to be performed or we're linking from the source,
 587   // bring over SGA.
 588   auto *PTy = cast<PointerType>(TypeMap.get(SGA->getType()));
 589   return GlobalAlias::create(PTy, SGA->getLinkage(), SGA->getName(), &DstM);
 590 }
 591
 592 static GlobalValue *copyGlobalValueProto(TypeMapTy &TypeMap, Module &DstM,
 593                                          const GlobalValue *SGV) {
 594   GlobalValue *NewGV;
 595   if (auto *SGVar = dyn_cast<GlobalVariable>(SGV))
 596     NewGV = copyGlobalVariableProto(TypeMap, DstM, SGVar);
 597   else if (auto *SF = dyn_cast<Function>(SGV))
 598     NewGV = copyFunctionProto(TypeMap, DstM, SF);
 599   else
 600     NewGV = copyGlobalAliasProto(TypeMap, DstM, cast<GlobalAlias>(SGV));
 601   copyGVAttributes(NewGV, SGV);
 602   return NewGV;
 603 }
 604
 605 Value *ValueMaterializerTy::materializeValueFor(Value *V) {
 606   auto *SGV = dyn_cast<GlobalValue>(V);
 607   if (!SGV)
 608     return nullptr;
 609
 610   GlobalValue *DGV = copyGlobalValueProto(TypeMap, *DstM, SGV);
 611
 612   if (Comdat *SC = SGV->getComdat()) {
 613     if (auto *DGO = dyn_cast<GlobalObject>(DGV)) {
 614       Comdat *DC = DstM->getOrInsertComdat(SC->getName());
 615       DGO->setComdat(DC);
 616     }
 617   }
 618
 619   LazilyLinkGlobalValues.push_back(SGV);
 620   return DGV;
 621 }
 622
 623 bool ModuleLinker::getComdatLeader(Module *M, StringRef ComdatName,
 624                                    const GlobalVariable *&GVar) {
 625   const GlobalValue *GVal = M->getNamedValue(ComdatName);
 626   if (const auto *GA = dyn_cast_or_null<GlobalAlias>(GVal)) {
 627     GVal = GA->getBaseObject();
 628     if (!GVal)
 629       // We cannot resolve the size of the aliasee yet.
 630       return emitError("Linking COMDATs named '" + ComdatName +
 631                        "': COMDAT key involves incomputable alias size.");
 632   }
 633
 634   GVar = dyn_cast_or_null<GlobalVariable>(GVal);
 635   if (!GVar)
 636     return emitError(
 637         "Linking COMDATs named '" + ComdatName +
 638         "': GlobalVariable required for data dependent selection!");
 639
 640   return false;
 641 }
 642
 643 bool ModuleLinker::computeResultingSelectionKind(StringRef ComdatName,
 644                                                  Comdat::SelectionKind Src,
 645                                                  Comdat::SelectionKind Dst,
 646                                                  Comdat::SelectionKind &Result,
 647                                                  bool &LinkFromSrc) {
 648   // The ability to mix Comdat::SelectionKind::Any with
 649   // Comdat::SelectionKind::Largest is a behavior that comes from COFF.
 650   bool DstAnyOrLargest = Dst == Comdat::SelectionKind::Any ||
 651                          Dst == Comdat::SelectionKind::Largest;
 652   bool SrcAnyOrLargest = Src == Comdat::SelectionKind::Any ||
 653                          Src == Comdat::SelectionKind::Largest;
 654   if (DstAnyOrLargest && SrcAnyOrLargest) {
 655     if (Dst == Comdat::SelectionKind::Largest ||
 656         Src == Comdat::SelectionKind::Largest)
 657       Result = Comdat::SelectionKind::Largest;
 658     else
 659       Result = Comdat::SelectionKind::Any;
 660   } else if (Src == Dst) {
 661     Result = Dst;
 662   } else {
 663     return emitError("Linking COMDATs named '" + ComdatName +
 664                      "': invalid selection kinds!");
 665   }
 666
 667   switch (Result) {
 668   case Comdat::SelectionKind::Any:
 669     // Go with Dst.
 670     LinkFromSrc = false;
 671     break;
 672   case Comdat::SelectionKind::NoDuplicates:
 673     return emitError("Linking COMDATs named '" + ComdatName +
 674                      "': noduplicates has been violated!");
 675   case Comdat::SelectionKind::ExactMatch:
 676   case Comdat::SelectionKind::Largest:
 677   case Comdat::SelectionKind::SameSize: {
 678     const GlobalVariable *DstGV;
 679     const GlobalVariable *SrcGV;
 680     if (getComdatLeader(DstM, ComdatName, DstGV) ||
 681         getComdatLeader(SrcM, ComdatName, SrcGV))
 682       return true;
 683
 684     const DataLayout &DstDL = DstM->getDataLayout();
 685     const DataLayout &SrcDL = SrcM->getDataLayout();
 686     uint64_t DstSize =
 687         DstDL.getTypeAllocSize(DstGV->getType()->getPointerElementType());
 688     uint64_t SrcSize =
 689         SrcDL.getTypeAllocSize(SrcGV->getType()->getPointerElementType());
 690     if (Result == Comdat::SelectionKind::ExactMatch) {
 691       if (SrcGV->getInitializer() != DstGV->getInitializer())
 692         return emitError("Linking COMDATs named '" + ComdatName +
 693                          "': ExactMatch violated!");
 694       LinkFromSrc = false;
 695     } else if (Result == Comdat::SelectionKind::Largest) {
 696       LinkFromSrc = SrcSize > DstSize;
 697     } else if (Result == Comdat::SelectionKind::SameSize) {
 698       if (SrcSize != DstSize)
 699         return emitError("Linking COMDATs named '" + ComdatName +
 700                          "': SameSize violated!");
 701       LinkFromSrc = false;
 702     } else {
 703       llvm_unreachable("unknown selection kind");
 704     }
 705     break;
 706   }
 707   }
 708
 709   return false;
 710 }
 711
 712 bool ModuleLinker::getComdatResult(const Comdat *SrcC,
 713                                    Comdat::SelectionKind &Result,
 714                                    bool &LinkFromSrc) {
 715   Comdat::SelectionKind SSK = SrcC->getSelectionKind();
 716   StringRef ComdatName = SrcC->getName();
 717   Module::ComdatSymTabType &ComdatSymTab = DstM->getComdatSymbolTable();
 718   Module::ComdatSymTabType::iterator DstCI = ComdatSymTab.find(ComdatName);
 719
 720   if (DstCI == ComdatSymTab.end()) {
 721     // Use the comdat if it is only available in one of the modules.
 722     LinkFromSrc = true;
 723     Result = SSK;
 724     return false;
 725   }
 726
 727   const Comdat *DstC = &DstCI->second;
 728   Comdat::SelectionKind DSK = DstC->getSelectionKind();
 729   return computeResultingSelectionKind(ComdatName, SSK, DSK, Result,
 730                                        LinkFromSrc);
 731 }
 732
 733 bool ModuleLinker::shouldLinkFromSource(bool &LinkFromSrc,
 734                                         const GlobalValue &Dest,
 735                                         const GlobalValue &Src) {
 736   // Should we unconditionally use the Src?
 737   if (shouldOverrideFromSrc()) {
 738     LinkFromSrc = true;
 739     return false;
 740   }
 741
 742   // We always have to add Src if it has appending linkage.
 743   if (Src.hasAppendingLinkage()) {
 744     LinkFromSrc = true;
 745     return false;
 746   }
 747
 748   bool SrcIsDeclaration = Src.isDeclarationForLinker();
 749   bool DestIsDeclaration = Dest.isDeclarationForLinker();
 750
 751   if (SrcIsDeclaration) {
 752     // If Src is external or if both Src & Dest are external..  Just link the
 753     // external globals, we aren't adding anything.
 754     if (Src.hasDLLImportStorageClass()) {
 755       // If one of GVs is marked as DLLImport, result should be dllimport'ed.
 756       LinkFromSrc = DestIsDeclaration;
 757       return false;
 758     }
 759     // If the Dest is weak, use the source linkage.
 760     LinkFromSrc = Dest.hasExternalWeakLinkage();
 761     return false;
 762   }
 763
 764   if (DestIsDeclaration) {
 765     // If Dest is external but Src is not:
 766     LinkFromSrc = true;
 767     return false;
 768   }
 769
 770   if (Src.hasCommonLinkage()) {
 771     if (Dest.hasLinkOnceLinkage() || Dest.hasWeakLinkage()) {
 772       LinkFromSrc = true;
 773       return false;
 774     }
 775
 776     if (!Dest.hasCommonLinkage()) {
 777       LinkFromSrc = false;
 778       return false;
 779     }
 780
 781     const DataLayout &DL = Dest.getParent()->getDataLayout();
 782     uint64_t DestSize = DL.getTypeAllocSize(Dest.getType()->getElementType());
 783     uint64_t SrcSize = DL.getTypeAllocSize(Src.getType()->getElementType());
 784     LinkFromSrc = SrcSize > DestSize;
 785     return false;
 786   }
 787
 788   if (Src.isWeakForLinker()) {
 789     assert(!Dest.hasExternalWeakLinkage());
 790     assert(!Dest.hasAvailableExternallyLinkage());
 791
 792     if (Dest.hasLinkOnceLinkage() && Src.hasWeakLinkage()) {
 793       LinkFromSrc = true;
 794       return false;
 795     }
 796
 797     LinkFromSrc = false;
 798     return false;
 799   }
 800
 801   if (Dest.isWeakForLinker()) {
 802     assert(Src.hasExternalLinkage());
 803     LinkFromSrc = true;
 804     return false;
 805   }
 806
 807   assert(!Src.hasExternalWeakLinkage());
 808   assert(!Dest.hasExternalWeakLinkage());
 809   assert(Dest.hasExternalLinkage() && Src.hasExternalLinkage() &&
 810          "Unexpected linkage type!");
 811   return emitError("Linking globals named '" + Src.getName() +
 812                    "': symbol multiply defined!");
 813 }
 814
 815 /// Loop over all of the linked values to compute type mappings.  For example,
 816 /// if we link "extern Foo *x" and "Foo *x = NULL", then we have two struct
 817 /// types 'Foo' but one got renamed when the module was loaded into the same
 818 /// LLVMContext.
 819 void ModuleLinker::computeTypeMapping() {
 820   for (GlobalValue &SGV : SrcM->globals()) {
 821     GlobalValue *DGV = getLinkedToGlobal(&SGV);
 822     if (!DGV)
 823       continue;
 824
 825     if (!DGV->hasAppendingLinkage() || !SGV.hasAppendingLinkage()) {
 826       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
 827       continue;
 828     }
 829
 830     // Unify the element type of appending arrays.
 831     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
 832     ArrayType *SAT = cast<ArrayType>(SGV.getType()->getElementType());
 833     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
 834   }
 835
 836   for (GlobalValue &SGV : *SrcM) {
 837     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
 838       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
 839   }
 840
 841   for (GlobalValue &SGV : SrcM->aliases()) {
 842     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
 843       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
 844   }
 845
 846   // Incorporate types by name, scanning all the types in the source module.
 847   // At this point, the destination module may have a type "%foo = { i32 }" for
 848   // example.  When the source module got loaded into the same LLVMContext, if
 849   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
 850   std::vector<StructType *> Types = SrcM->getIdentifiedStructTypes();
 851   for (StructType *ST : Types) {
 852     if (!ST->hasName())
 853       continue;
 854
 855     // Check to see if there is a dot in the name followed by a digit.
 856     size_t DotPos = ST->getName().rfind('.');
 857     if (DotPos == 0 || DotPos == StringRef::npos ||
 858         ST->getName().back() == '.' ||
 859         !isdigit(static_cast<unsigned char>(ST->getName()[DotPos + 1])))
 860       continue;
 861
 862     // Check to see if the destination module has a struct with the prefix name.
 863     StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos));
 864     if (!DST)
 865       continue;
 866
 867     // Don't use it if this actually came from the source module. They're in
 868     // the same LLVMContext after all. Also don't use it unless the type is
 869     // actually used in the destination module. This can happen in situations
 870     // like this:
 871     //
 872     //      Module A                         Module B
 873     //      --------                         --------
 874     //   %Z = type { %A }                %B = type { %C.1 }
 875     //   %A = type { %B.1, [7 x i8] }    %C.1 = type { i8* }
 876     //   %B.1 = type { %C }              %A.2 = type { %B.3, [5 x i8] }
 877     //   %C = type { i8* }               %B.3 = type { %C.1 }
 878     //
 879     // When we link Module B with Module A, the '%B' in Module B is
 880     // used. However, that would then use '%C.1'. But when we process '%C.1',
 881     // we prefer to take the '%C' version. So we are then left with both
 882     // '%C.1' and '%C' being used for the same types. This leads to some
 883     // variables using one type and some using the other.
 884     if (TypeMap.DstStructTypesSet.hasType(DST))
 885       TypeMap.addTypeMapping(DST, ST);
 886   }
 887
 888   // Now that we have discovered all of the type equivalences, get a body for
 889   // any 'opaque' types in the dest module that are now resolved.
 890   TypeMap.linkDefinedTypeBodies();
 891 }
 892
 893 static void upgradeGlobalArray(GlobalVariable *GV) {
 894   ArrayType *ATy = cast<ArrayType>(GV->getType()->getElementType());
 895   StructType *OldTy = cast<StructType>(ATy->getElementType());
 896   assert(OldTy->getNumElements() == 2 && "Expected to upgrade from 2 elements");
 897
 898   // Get the upgraded 3 element type.
 899   PointerType *VoidPtrTy = Type::getInt8Ty(GV->getContext())->getPointerTo();
 900   Type *Tys[3] = {OldTy->getElementType(0), OldTy->getElementType(1),
 901                   VoidPtrTy};
 902   StructType *NewTy = StructType::get(GV->getContext(), Tys, false);
 903
 904   // Build new constants with a null third field filled in.
 905   Constant *OldInitC = GV->getInitializer();
 906   ConstantArray *OldInit = dyn_cast<ConstantArray>(OldInitC);
 907   if (!OldInit && !isa<ConstantAggregateZero>(OldInitC))
 908     // Invalid initializer; give up.
 909     return;
 910   std::vector<Constant *> Initializers;
 911   if (OldInit && OldInit->getNumOperands()) {
 912     Value *Null = Constant::getNullValue(VoidPtrTy);
 913     for (Use &U : OldInit->operands()) {
 914       ConstantStruct *Init = cast<ConstantStruct>(U.get());
 915       Initializers.push_back(ConstantStruct::get(
 916           NewTy, Init->getOperand(0), Init->getOperand(1), Null, nullptr));
 917     }
 918   }
 919   assert(Initializers.size() == ATy->getNumElements() &&
 920          "Failed to copy all array elements");
 921
 922   // Replace the old GV with a new one.
 923   ATy = ArrayType::get(NewTy, Initializers.size());
 924   Constant *NewInit = ConstantArray::get(ATy, Initializers);
 925   GlobalVariable *NewGV = new GlobalVariable(
 926       *GV->getParent(), ATy, GV->isConstant(), GV->getLinkage(), NewInit, "",
 927       GV, GV->getThreadLocalMode(), GV->getType()->getAddressSpace(),
 928       GV->isExternallyInitialized());
 929   NewGV->copyAttributesFrom(GV);
 930   NewGV->takeName(GV);
 931   assert(GV->use_empty() && "program cannot use initializer list");
 932   GV->eraseFromParent();
 933 }
 934
 935 void ModuleLinker::upgradeMismatchedGlobalArray(StringRef Name) {
 936   // Look for the global arrays.
 937   auto *DstGV = dyn_cast_or_null<GlobalVariable>(DstM->getNamedValue(Name));
 938   if (!DstGV)
 939     return;
 940   auto *SrcGV = dyn_cast_or_null<GlobalVariable>(SrcM->getNamedValue(Name));
 941   if (!SrcGV)
 942     return;
 943
 944   // Check if the types already match.
 945   auto *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
 946   auto *SrcTy =
 947       cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
 948   if (DstTy == SrcTy)
 949     return;
 950
 951   // Grab the element types.  We can only upgrade an array of a two-field
 952   // struct.  Only bother if the other one has three-fields.
 953   auto *DstEltTy = cast<StructType>(DstTy->getElementType());
 954   auto *SrcEltTy = cast<StructType>(SrcTy->getElementType());
 955   if (DstEltTy->getNumElements() == 2 && SrcEltTy->getNumElements() == 3) {
 956     upgradeGlobalArray(DstGV);
 957     return;
 958   }
 959   if (DstEltTy->getNumElements() == 3 && SrcEltTy->getNumElements() == 2)
 960     upgradeGlobalArray(SrcGV);
 961
 962   // We can't upgrade any other differences.
 963 }
 964
 965 void ModuleLinker::upgradeMismatchedGlobals() {
 966   upgradeMismatchedGlobalArray("llvm.global_ctors");
 967   upgradeMismatchedGlobalArray("llvm.global_dtors");
 968 }
 969
 970 /// If there were any appending global variables, link them together now.
 971 /// Return true on error.
 972 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
 973                                          const GlobalVariable *SrcGV) {
 974
 975   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
 976     return emitError("Linking globals named '" + SrcGV->getName() +
 977            "': can only link appending global with another appending global!");
 978
 979   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
 980   ArrayType *SrcTy =
 981     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
 982   Type *EltTy = DstTy->getElementType();
 983
 984   // Check to see that they two arrays agree on type.
 985   if (EltTy != SrcTy->getElementType())
 986     return emitError("Appending variables with different element types!");
 987   if (DstGV->isConstant() != SrcGV->isConstant())
 988     return emitError("Appending variables linked with different const'ness!");
 989
 990   if (DstGV->getAlignment() != SrcGV->getAlignment())
 991     return emitError(
 992              "Appending variables with different alignment need to be linked!");
 993
 994   if (DstGV->getVisibility() != SrcGV->getVisibility())
 995     return emitError(
 996             "Appending variables with different visibility need to be linked!");
 997
 998   if (DstGV->hasUnnamedAddr() != SrcGV->hasUnnamedAddr())
 999     return emitError(
1000         "Appending variables with different unnamed_addr need to be linked!");
1001
1002   if (StringRef(DstGV->getSection()) != SrcGV->getSection())
1003     return emitError(
1004           "Appending variables with different section name need to be linked!");
1005
1006   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
1007   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
1008
1009   // Create the new global variable.
1010   GlobalVariable *NG =
1011     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
1012                        DstGV->getLinkage(), /*init*/nullptr, /*name*/"", DstGV,
1013                        DstGV->getThreadLocalMode(),
1014                        DstGV->getType()->getAddressSpace());
1015
1016   // Propagate alignment, visibility and section info.
1017   copyGVAttributes(NG, DstGV);
1018
1019   AppendingVarInfo AVI;
1020   AVI.NewGV = NG;
1021   AVI.DstInit = DstGV->getInitializer();
1022   AVI.SrcInit = SrcGV->getInitializer();
1023   AppendingVars.push_back(AVI);
1024
1025   // Replace any uses of the two global variables with uses of the new
1026   // global.
1027   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
1028
1029   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
1030   DstGV->eraseFromParent();
1031
1032   // Track the source variable so we don't try to link it.
1033   DoNotLinkFromSource.insert(SrcGV);
1034
1035   return false;
1036 }
1037
1038 bool ModuleLinker::linkGlobalValueProto(GlobalValue *SGV) {
1039   GlobalValue *DGV = getLinkedToGlobal(SGV);
1040
1041   // Handle the ultra special appending linkage case first.
1042   if (DGV && DGV->hasAppendingLinkage())
1043     return linkAppendingVarProto(cast<GlobalVariable>(DGV),
1044                                  cast<GlobalVariable>(SGV));
1045
1046   bool LinkFromSrc = true;
1047   Comdat *C = nullptr;
1048   GlobalValue::VisibilityTypes Visibility = SGV->getVisibility();
1049   bool HasUnnamedAddr = SGV->hasUnnamedAddr();
1050
1051   if (const Comdat *SC = SGV->getComdat()) {
1052     Comdat::SelectionKind SK;
1053     std::tie(SK, LinkFromSrc) = ComdatsChosen[SC];
1054     C = DstM->getOrInsertComdat(SC->getName());
1055     C->setSelectionKind(SK);
1056   } else if (DGV) {
1057     if (shouldLinkFromSource(LinkFromSrc, *DGV, *SGV))
1058       return true;
1059   }
1060
1061   if (!LinkFromSrc) {
1062     // Track the source global so that we don't attempt to copy it over when
1063     // processing global initializers.
1064     DoNotLinkFromSource.insert(SGV);
1065
1066     if (DGV)
1067       // Make sure to remember this mapping.
1068       ValueMap[SGV] =
1069           ConstantExpr::getBitCast(DGV, TypeMap.get(SGV->getType()));
1070   }
1071
1072   if (DGV) {
1073     Visibility = isLessConstraining(Visibility, DGV->getVisibility())
1074                      ? DGV->getVisibility()
1075                      : Visibility;
1076     HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr();
1077   }
1078
1079   if (!LinkFromSrc && !DGV)
1080     return false;
1081
1082   GlobalValue *NewGV;
1083   if (!LinkFromSrc) {
1084     NewGV = DGV;
1085   } else {
1086     // If the GV is to be lazily linked, don't create it just yet.
1087     // The ValueMaterializerTy will deal with creating it if it's used.
1088     if (!DGV && !shouldOverrideFromSrc() &&
1089         (SGV->hasLocalLinkage() || SGV->hasLinkOnceLinkage() ||
1090          SGV->hasAvailableExternallyLinkage())) {
1091       DoNotLinkFromSource.insert(SGV);
1092       return false;
1093     }
1094
1095     // When we only want to link in unresolved dependencies, blacklist
1096     // the symbol unless unless DestM has a matching declaration (DGV).
1097     if (shouldLinkOnlyNeeded() && !(DGV && DGV->isDeclaration())) {
1098       DoNotLinkFromSource.insert(SGV);
1099       return false;
1100     }
1101
1102     NewGV = copyGlobalValueProto(TypeMap, *DstM, SGV);
1103
1104     if (DGV && isa<Function>(DGV))
1105       if (auto *NewF = dyn_cast<Function>(NewGV))
1106         OverridingFunctions.insert(NewF);
1107   }
1108
1109   NewGV->setUnnamedAddr(HasUnnamedAddr);
1110   NewGV->setVisibility(Visibility);
1111
1112   if (auto *NewGO = dyn_cast<GlobalObject>(NewGV)) {
1113     if (C)
1114       NewGO->setComdat(C);
1115
1116     if (DGV && DGV->hasCommonLinkage() && SGV->hasCommonLinkage())
1117       NewGO->setAlignment(std::max(DGV->getAlignment(), SGV->getAlignment()));
1118   }
1119
1120   if (auto *NewGVar = dyn_cast<GlobalVariable>(NewGV)) {
1121     auto *DGVar = dyn_cast_or_null<GlobalVariable>(DGV);
1122     auto *SGVar = dyn_cast<GlobalVariable>(SGV);
1123     if (DGVar && SGVar && DGVar->isDeclaration() && SGVar->isDeclaration() &&
1124         (!DGVar->isConstant() || !SGVar->isConstant()))
1125       NewGVar->setConstant(false);
1126   }
1127
1128   // Make sure to remember this mapping.
1129   if (NewGV != DGV) {
1130     if (DGV) {
1131       DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewGV, DGV->getType()));
1132       DGV->eraseFromParent();
1133     }
1134     ValueMap[SGV] = NewGV;
1135   }
1136
1137   return false;
1138 }
1139
1140 static void getArrayElements(const Constant *C,
1141                              SmallVectorImpl<Constant *> &Dest) {
1142   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
1143
1144   for (unsigned i = 0; i != NumElements; ++i)
1145     Dest.push_back(C->getAggregateElement(i));
1146 }
1147
1148 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
1149   // Merge the initializer.
1150   SmallVector<Constant *, 16> DstElements;
1151   getArrayElements(AVI.DstInit, DstElements);
1152
1153   SmallVector<Constant *, 16> SrcElements;
1154   getArrayElements(AVI.SrcInit, SrcElements);
1155
1156   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
1157
1158   StringRef Name = AVI.NewGV->getName();
1159   bool IsNewStructor =
1160       (Name == "llvm.global_ctors" || Name == "llvm.global_dtors") &&
1161       cast<StructType>(NewType->getElementType())->getNumElements() == 3;
1162
1163   for (auto *V : SrcElements) {
1164     if (IsNewStructor) {
1165       Constant *Key = V->getAggregateElement(2);
1166       if (DoNotLinkFromSource.count(Key))
1167         continue;
1168     }
1169     DstElements.push_back(
1170         MapValue(V, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1171   }
1172   if (IsNewStructor) {
1173     NewType = ArrayType::get(NewType->getElementType(), DstElements.size());
1174     AVI.NewGV->mutateType(PointerType::get(NewType, 0));
1175   }
1176
1177   AVI.NewGV->setInitializer(ConstantArray::get(NewType, DstElements));
1178 }
1179
1180 /// Update the initializers in the Dest module now that all globals that may be
1181 /// referenced are in Dest.
1182 void ModuleLinker::linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src) {
1183   // Figure out what the initializer looks like in the dest module.
1184   Dst.setInitializer(MapValue(Src.getInitializer(), ValueMap,
1185                               RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1186 }
1187
1188 /// Copy the source function over into the dest function and fix up references
1189 /// to values. At this point we know that Dest is an external function, and
1190 /// that Src is not.
1191 bool ModuleLinker::linkFunctionBody(Function &Dst, Function &Src) {
1192   assert(Dst.isDeclaration() && !Src.isDeclaration());
1193
1194   // Materialize if needed.
1195   if (std::error_code EC = Src.materialize())
1196     return emitError(EC.message());
1197
1198   // Link in the prefix data.
1199   if (Src.hasPrefixData())
1200     Dst.setPrefixData(MapValue(Src.getPrefixData(), ValueMap,
1201                                RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1202
1203   // Link in the prologue data.
1204   if (Src.hasPrologueData())
1205     Dst.setPrologueData(MapValue(Src.getPrologueData(), ValueMap,
1206                                  RF_MoveDistinctMDs, &TypeMap,
1207                                  &ValMaterializer));
1208
1209   // Link in the personality function.
1210   if (Src.hasPersonalityFn())
1211     Dst.setPersonalityFn(MapValue(Src.getPersonalityFn(), ValueMap,
1212                                   RF_MoveDistinctMDs, &TypeMap,
1213                                   &ValMaterializer));
1214
1215   // Go through and convert function arguments over, remembering the mapping.
1216   Function::arg_iterator DI = Dst.arg_begin();
1217   for (Argument &Arg : Src.args()) {
1218     DI->setName(Arg.getName());  // Copy the name over.
1219
1220     // Add a mapping to our mapping.
1221     ValueMap[&Arg] = DI;
1222     ++DI;
1223   }
1224
1225   // Copy over the metadata attachments.
1226   SmallVector<std::pair<unsigned, MDNode *>, 8> MDs;
1227   Src.getAllMetadata(MDs);
1228   for (const auto &I : MDs)
1229     Dst.setMetadata(I.first, MapMetadata(I.second, ValueMap, RF_MoveDistinctMDs,
1230                                          &TypeMap, &ValMaterializer));
1231
1232   // Splice the body of the source function into the dest function.
1233   Dst.getBasicBlockList().splice(Dst.end(), Src.getBasicBlockList());
1234
1235   // At this point, all of the instructions and values of the function are now
1236   // copied over.  The only problem is that they are still referencing values in
1237   // the Source function as operands.  Loop through all of the operands of the
1238   // functions and patch them up to point to the local versions.
1239   for (BasicBlock &BB : Dst)
1240     for (Instruction &I : BB)
1241       RemapInstruction(&I, ValueMap,
1242                        RF_IgnoreMissingEntries | RF_MoveDistinctMDs, &TypeMap,
1243                        &ValMaterializer);
1244
1245   // There is no need to map the arguments anymore.
1246   for (Argument &Arg : Src.args())
1247     ValueMap.erase(&Arg);
1248
1249   Src.dematerialize();
1250   return false;
1251 }
1252
1253 void ModuleLinker::linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src) {
1254   Constant *Aliasee = Src.getAliasee();
1255   Constant *Val = MapValue(Aliasee, ValueMap, RF_MoveDistinctMDs, &TypeMap,
1256                            &ValMaterializer);
1257   Dst.setAliasee(Val);
1258 }
1259
1260 bool ModuleLinker::linkGlobalValueBody(GlobalValue &Src) {
1261   Value *Dst = ValueMap[&Src];
1262   assert(Dst);
1263   if (shouldInternalizeLinkedSymbols())
1264     if (auto *DGV = dyn_cast<GlobalValue>(Dst))
1265       DGV->setLinkage(GlobalValue::InternalLinkage);
1266   if (auto *F = dyn_cast<Function>(&Src))
1267     return linkFunctionBody(cast<Function>(*Dst), *F);
1268   if (auto *GVar = dyn_cast<GlobalVariable>(&Src)) {
1269     linkGlobalInit(cast<GlobalVariable>(*Dst), *GVar);
1270     return false;
1271   }
1272   linkAliasBody(cast<GlobalAlias>(*Dst), cast<GlobalAlias>(Src));
1273   return false;
1274 }
1275
1276 /// Insert all of the named MDNodes in Src into the Dest module.
1277 void ModuleLinker::linkNamedMDNodes() {
1278   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1279   for (const NamedMDNode &NMD : SrcM->named_metadata()) {
1280     // Don't link module flags here. Do them separately.
1281     if (&NMD == SrcModFlags)
1282       continue;
1283     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(NMD.getName());
1284     // Add Src elements into Dest node.
1285     for (const MDNode *op : NMD.operands())
1286       DestNMD->addOperand(MapMetadata(op, ValueMap, RF_MoveDistinctMDs,
1287                                       &TypeMap, &ValMaterializer));
1288   }
1289 }
1290
1291 /// Drop DISubprograms that have been superseded.
1292 ///
1293 /// FIXME: this creates an asymmetric result: we strip functions from losing
1294 /// subprograms in DstM, but leave losing subprograms in SrcM.
1295 /// TODO: Remove this logic once the backend can correctly determine canonical
1296 /// subprograms.
1297 void ModuleLinker::stripReplacedSubprograms() {
1298   // Avoid quadratic runtime by returning early when there's nothing to do.
1299   if (OverridingFunctions.empty())
1300     return;
1301
1302   // Move the functions now, so the set gets cleared even on early returns.
1303   auto Functions = std::move(OverridingFunctions);
1304   OverridingFunctions.clear();
1305
1306   // Drop functions from subprograms if they've been overridden by the new
1307   // compile unit.
1308   NamedMDNode *CompileUnits = DstM->getNamedMetadata("llvm.dbg.cu");
1309   if (!CompileUnits)
1310     return;
1311   for (unsigned I = 0, E = CompileUnits->getNumOperands(); I != E; ++I) {
1312     auto *CU = cast<DICompileUnit>(CompileUnits->getOperand(I));
1313     assert(CU && "Expected valid compile unit");
1314
1315     for (DISubprogram *SP : CU->getSubprograms()) {
1316       if (!SP || !SP->getFunction() || !Functions.count(SP->getFunction()))
1317         continue;
1318
1319       // Prevent DebugInfoFinder from tagging this as the canonical subprogram,
1320       // since the canonical one is in the incoming module.
1321       SP->replaceFunction(nullptr);
1322     }
1323   }
1324 }
1325
1326 /// Merge the linker flags in Src into the Dest module.
1327 bool ModuleLinker::linkModuleFlagsMetadata() {
1328   // If the source module has no module flags, we are done.
1329   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1330   if (!SrcModFlags) return false;
1331
1332   // If the destination module doesn't have module flags yet, then just copy
1333   // over the source module's flags.
1334   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
1335   if (DstModFlags->getNumOperands() == 0) {
1336     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
1337       DstModFlags->addOperand(SrcModFlags->getOperand(I));
1338
1339     return false;
1340   }
1341
1342   // First build a map of the existing module flags and requirements.
1343   DenseMap<MDString *, std::pair<MDNode *, unsigned>> Flags;
1344   SmallSetVector<MDNode*, 16> Requirements;
1345   for (unsigned I = 0, E = DstModFlags->getNumOperands(); I != E; ++I) {
1346     MDNode *Op = DstModFlags->getOperand(I);
1347     ConstantInt *Behavior = mdconst::extract<ConstantInt>(Op->getOperand(0));
1348     MDString *ID = cast<MDString>(Op->getOperand(1));
1349
1350     if (Behavior->getZExtValue() == Module::Require) {
1351       Requirements.insert(cast<MDNode>(Op->getOperand(2)));
1352     } else {
1353       Flags[ID] = std::make_pair(Op, I);
1354     }
1355   }
1356
1357   // Merge in the flags from the source module, and also collect its set of
1358   // requirements.
1359   bool HasErr = false;
1360   for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) {
1361     MDNode *SrcOp = SrcModFlags->getOperand(I);
1362     ConstantInt *SrcBehavior =
1363         mdconst::extract<ConstantInt>(SrcOp->getOperand(0));
1364     MDString *ID = cast<MDString>(SrcOp->getOperand(1));
1365     MDNode *DstOp;
1366     unsigned DstIndex;
1367     std::tie(DstOp, DstIndex) = Flags.lookup(ID);
1368     unsigned SrcBehaviorValue = SrcBehavior->getZExtValue();
1369
1370     // If this is a requirement, add it and continue.
1371     if (SrcBehaviorValue == Module::Require) {
1372       // If the destination module does not already have this requirement, add
1373       // it.
1374       if (Requirements.insert(cast<MDNode>(SrcOp->getOperand(2)))) {
1375         DstModFlags->addOperand(SrcOp);
1376       }
1377       continue;
1378     }
1379
1380     // If there is no existing flag with this ID, just add it.
1381     if (!DstOp) {
1382       Flags[ID] = std::make_pair(SrcOp, DstModFlags->getNumOperands());
1383       DstModFlags->addOperand(SrcOp);
1384       continue;
1385     }
1386
1387     // Otherwise, perform a merge.
1388     ConstantInt *DstBehavior =
1389         mdconst::extract<ConstantInt>(DstOp->getOperand(0));
1390     unsigned DstBehaviorValue = DstBehavior->getZExtValue();
1391
1392     // If either flag has override behavior, handle it first.
1393     if (DstBehaviorValue == Module::Override) {
1394       // Diagnose inconsistent flags which both have override behavior.
1395       if (SrcBehaviorValue == Module::Override &&
1396           SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1397         HasErr |= emitError("linking module flags '" + ID->getString() +
1398                             "': IDs have conflicting override values");
1399       }
1400       continue;
1401     } else if (SrcBehaviorValue == Module::Override) {
1402       // Update the destination flag to that of the source.
1403       DstModFlags->setOperand(DstIndex, SrcOp);
1404       Flags[ID].first = SrcOp;
1405       continue;
1406     }
1407
1408     // Diagnose inconsistent merge behavior types.
1409     if (SrcBehaviorValue != DstBehaviorValue) {
1410       HasErr |= emitError("linking module flags '" + ID->getString() +
1411                           "': IDs have conflicting behaviors");
1412       continue;
1413     }
1414
1415     auto replaceDstValue = [&](MDNode *New) {
1416       Metadata *FlagOps[] = {DstOp->getOperand(0), ID, New};
1417       MDNode *Flag = MDNode::get(DstM->getContext(), FlagOps);
1418       DstModFlags->setOperand(DstIndex, Flag);
1419       Flags[ID].first = Flag;
1420     };
1421
1422     // Perform the merge for standard behavior types.
1423     switch (SrcBehaviorValue) {
1424     case Module::Require:
1425     case Module::Override: llvm_unreachable("not possible");
1426     case Module::Error: {
1427       // Emit an error if the values differ.
1428       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1429         HasErr |= emitError("linking module flags '" + ID->getString() +
1430                             "': IDs have conflicting values");
1431       }
1432       continue;
1433     }
1434     case Module::Warning: {
1435       // Emit a warning if the values differ.
1436       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1437         emitWarning("linking module flags '" + ID->getString() +
1438                     "': IDs have conflicting values");
1439       }
1440       continue;
1441     }
1442     case Module::Append: {
1443       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1444       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1445       SmallVector<Metadata *, 8> MDs;
1446       MDs.reserve(DstValue->getNumOperands() + SrcValue->getNumOperands());
1447       MDs.append(DstValue->op_begin(), DstValue->op_end());
1448       MDs.append(SrcValue->op_begin(), SrcValue->op_end());
1449
1450       replaceDstValue(MDNode::get(DstM->getContext(), MDs));
1451       break;
1452     }
1453     case Module::AppendUnique: {
1454       SmallSetVector<Metadata *, 16> Elts;
1455       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1456       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1457       Elts.insert(DstValue->op_begin(), DstValue->op_end());
1458       Elts.insert(SrcValue->op_begin(), SrcValue->op_end());
1459
1460       replaceDstValue(MDNode::get(DstM->getContext(),
1461                                   makeArrayRef(Elts.begin(), Elts.end())));
1462       break;
1463     }
1464     }
1465   }
1466
1467   // Check all of the requirements.
1468   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1469     MDNode *Requirement = Requirements[I];
1470     MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1471     Metadata *ReqValue = Requirement->getOperand(1);
1472
1473     MDNode *Op = Flags[Flag].first;
1474     if (!Op || Op->getOperand(2) != ReqValue) {
1475       HasErr |= emitError("linking module flags '" + Flag->getString() +
1476                           "': does not have the required value");
1477       continue;
1478     }
1479   }
1480
1481   return HasErr;
1482 }
1483
1484 // This function returns true if the triples match.
1485 static bool triplesMatch(const Triple &T0, const Triple &T1) {
1486   // If vendor is apple, ignore the version number.
1487   if (T0.getVendor() == Triple::Apple)
1488     return T0.getArch() == T1.getArch() &&
1489            T0.getSubArch() == T1.getSubArch() &&
1490            T0.getVendor() == T1.getVendor() &&
1491            T0.getOS() == T1.getOS();
1492
1493   return T0 == T1;
1494 }
1495
1496 // This function returns the merged triple.
1497 static std::string mergeTriples(const Triple &SrcTriple, const Triple &DstTriple) {
1498   // If vendor is apple, pick the triple with the larger version number.
1499   if (SrcTriple.getVendor() == Triple::Apple)
1500     if (DstTriple.isOSVersionLT(SrcTriple))
1501       return SrcTriple.str();
1502
1503   return DstTriple.str();
1504 }
1505
1506 bool ModuleLinker::run() {
1507   assert(DstM && "Null destination module");
1508   assert(SrcM && "Null source module");
1509
1510   // Inherit the target data from the source module if the destination module
1511   // doesn't have one already.
1512   if (DstM->getDataLayout().isDefault())
1513     DstM->setDataLayout(SrcM->getDataLayout());
1514
1515   if (SrcM->getDataLayout() != DstM->getDataLayout()) {
1516     emitWarning("Linking two modules of different data layouts: '" +
1517                 SrcM->getModuleIdentifier() + "' is '" +
1518                 SrcM->getDataLayoutStr() + "' whereas '" +
1519                 DstM->getModuleIdentifier() + "' is '" +
1520                 DstM->getDataLayoutStr() + "'\n");
1521   }
1522
1523   // Copy the target triple from the source to dest if the dest's is empty.
1524   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1525     DstM->setTargetTriple(SrcM->getTargetTriple());
1526
1527   Triple SrcTriple(SrcM->getTargetTriple()), DstTriple(DstM->getTargetTriple());
1528
1529   if (!SrcM->getTargetTriple().empty() && !triplesMatch(SrcTriple, DstTriple))
1530     emitWarning("Linking two modules of different target triples: " +
1531                 SrcM->getModuleIdentifier() + "' is '" +
1532                 SrcM->getTargetTriple() + "' whereas '" +
1533                 DstM->getModuleIdentifier() + "' is '" +
1534                 DstM->getTargetTriple() + "'\n");
1535
1536   DstM->setTargetTriple(mergeTriples(SrcTriple, DstTriple));
1537
1538   // Append the module inline asm string.
1539   if (!SrcM->getModuleInlineAsm().empty()) {
1540     if (DstM->getModuleInlineAsm().empty())
1541       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1542     else
1543       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1544                                SrcM->getModuleInlineAsm());
1545   }
1546
1547   // Loop over all of the linked values to compute type mappings.
1548   computeTypeMapping();
1549
1550   ComdatsChosen.clear();
1551   for (const auto &SMEC : SrcM->getComdatSymbolTable()) {
1552     const Comdat &C = SMEC.getValue();
1553     if (ComdatsChosen.count(&C))
1554       continue;
1555     Comdat::SelectionKind SK;
1556     bool LinkFromSrc;
1557     if (getComdatResult(&C, SK, LinkFromSrc))
1558       return true;
1559     ComdatsChosen[&C] = std::make_pair(SK, LinkFromSrc);
1560   }
1561
1562   // Upgrade mismatched global arrays.
1563   upgradeMismatchedGlobals();
1564
1565   // Insert all of the globals in src into the DstM module... without linking
1566   // initializers (which could refer to functions not yet mapped over).
1567   for (GlobalVariable &GV : SrcM->globals())
1568     if (linkGlobalValueProto(&GV))
1569       return true;
1570
1571   // Link the functions together between the two modules, without doing function
1572   // bodies... this just adds external function prototypes to the DstM
1573   // function...  We do this so that when we begin processing function bodies,
1574   // all of the global values that may be referenced are available in our
1575   // ValueMap.
1576   for (Function &F :*SrcM)
1577     if (linkGlobalValueProto(&F))
1578       return true;
1579
1580   // If there were any aliases, link them now.
1581   for (GlobalAlias &GA : SrcM->aliases())
1582     if (linkGlobalValueProto(&GA))
1583       return true;
1584
1585   for (const AppendingVarInfo &AppendingVar : AppendingVars)
1586     linkAppendingVarInit(AppendingVar);
1587
1588   for (const auto &Entry : DstM->getComdatSymbolTable()) {
1589     const Comdat &C = Entry.getValue();
1590     if (C.getSelectionKind() == Comdat::Any)
1591       continue;
1592     const GlobalValue *GV = SrcM->getNamedValue(C.getName());
1593     if (GV)
1594       MapValue(GV, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer);
1595   }
1596
1597   // Strip replaced subprograms before mapping any metadata -- so that we're
1598   // not changing metadata from the source module (note that
1599   // linkGlobalValueBody() eventually calls RemapInstruction() and therefore
1600   // MapMetadata()) -- but after linking global value protocols -- so that
1601   // OverridingFunctions has been built.
1602   stripReplacedSubprograms();
1603
1604   // Link in the function bodies that are defined in the source module into
1605   // DstM.
1606   for (Function &SF : *SrcM) {
1607     // Skip if no body (function is external).
1608     if (SF.isDeclaration())
1609       continue;
1610
1611     // Skip if not linking from source.
1612     if (DoNotLinkFromSource.count(&SF))
1613       continue;
1614
1615     if (linkGlobalValueBody(SF))
1616       return true;
1617   }
1618
1619   // Resolve all uses of aliases with aliasees.
1620   for (GlobalAlias &Src : SrcM->aliases()) {
1621     if (DoNotLinkFromSource.count(&Src))
1622       continue;
1623     linkGlobalValueBody(Src);
1624   }
1625
1626   // Remap all of the named MDNodes in Src into the DstM module. We do this
1627   // after linking GlobalValues so that MDNodes that reference GlobalValues
1628   // are properly remapped.
1629   linkNamedMDNodes();
1630
1631   // Merge the module flags into the DstM module.
1632   if (linkModuleFlagsMetadata())
1633     return true;
1634
1635   // Update the initializers in the DstM module now that all globals that may
1636   // be referenced are in DstM.
1637   for (GlobalVariable &Src : SrcM->globals()) {
1638     // Only process initialized GV's or ones not already in dest.
1639     if (!Src.hasInitializer() || DoNotLinkFromSource.count(&Src))
1640       continue;
1641     linkGlobalValueBody(Src);
1642   }
1643
1644   // Process vector of lazily linked in functions.
1645   while (!LazilyLinkGlobalValues.empty()) {
1646     GlobalValue *SGV = LazilyLinkGlobalValues.back();
1647     LazilyLinkGlobalValues.pop_back();
1648
1649     // Skip declarations that ValueMaterializer may have created in
1650     // case we link in only some of SrcM.
1651     if (shouldLinkOnlyNeeded() && SGV->isDeclaration())
1652       continue;
1653
1654     assert(!SGV->isDeclaration() && "users should not pass down decls");
1655     if (linkGlobalValueBody(*SGV))
1656       return true;
1657   }
1658
1659   return false;
1660 }
1661
1662 Linker::StructTypeKeyInfo::KeyTy::KeyTy(ArrayRef<Type *> E, bool P)
1663     : ETypes(E), IsPacked(P) {}
1664
1665 Linker::StructTypeKeyInfo::KeyTy::KeyTy(const StructType *ST)
1666     : ETypes(ST->elements()), IsPacked(ST->isPacked()) {}
1667
1668 bool Linker::StructTypeKeyInfo::KeyTy::operator==(const KeyTy &That) const {
1669   if (IsPacked != That.IsPacked)
1670     return false;
1671   if (ETypes != That.ETypes)
1672     return false;
1673   return true;
1674 }
1675
1676 bool Linker::StructTypeKeyInfo::KeyTy::operator!=(const KeyTy &That) const {
1677   return !this->operator==(That);
1678 }
1679
1680 StructType *Linker::StructTypeKeyInfo::getEmptyKey() {
1681   return DenseMapInfo<StructType *>::getEmptyKey();
1682 }
1683
1684 StructType *Linker::StructTypeKeyInfo::getTombstoneKey() {
1685   return DenseMapInfo<StructType *>::getTombstoneKey();
1686 }
1687
1688 unsigned Linker::StructTypeKeyInfo::getHashValue(const KeyTy &Key) {
1689   return hash_combine(hash_combine_range(Key.ETypes.begin(), Key.ETypes.end()),
1690                       Key.IsPacked);
1691 }
1692
1693 unsigned Linker::StructTypeKeyInfo::getHashValue(const StructType *ST) {
1694   return getHashValue(KeyTy(ST));
1695 }
1696
1697 bool Linker::StructTypeKeyInfo::isEqual(const KeyTy &LHS,
1698                                         const StructType *RHS) {
1699   if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1700     return false;
1701   return LHS == KeyTy(RHS);
1702 }
1703
1704 bool Linker::StructTypeKeyInfo::isEqual(const StructType *LHS,
1705                                         const StructType *RHS) {
1706   if (RHS == getEmptyKey())
1707     return LHS == getEmptyKey();
1708
1709   if (RHS == getTombstoneKey())
1710     return LHS == getTombstoneKey();
1711
1712   return KeyTy(LHS) == KeyTy(RHS);
1713 }
1714
1715 void Linker::IdentifiedStructTypeSet::addNonOpaque(StructType *Ty) {
1716   assert(!Ty->isOpaque());
1717   NonOpaqueStructTypes.insert(Ty);
1718 }
1719
1720 void Linker::IdentifiedStructTypeSet::switchToNonOpaque(StructType *Ty) {
1721   assert(!Ty->isOpaque());
1722   NonOpaqueStructTypes.insert(Ty);
1723   bool Removed = OpaqueStructTypes.erase(Ty);
1724   (void)Removed;
1725   assert(Removed);
1726 }
1727
1728 void Linker::IdentifiedStructTypeSet::addOpaque(StructType *Ty) {
1729   assert(Ty->isOpaque());
1730   OpaqueStructTypes.insert(Ty);
1731 }
1732
1733 StructType *
1734 Linker::IdentifiedStructTypeSet::findNonOpaque(ArrayRef<Type *> ETypes,
1735                                                bool IsPacked) {
1736   Linker::StructTypeKeyInfo::KeyTy Key(ETypes, IsPacked);
1737   auto I = NonOpaqueStructTypes.find_as(Key);
1738   if (I == NonOpaqueStructTypes.end())
1739     return nullptr;
1740   return *I;
1741 }
1742
1743 bool Linker::IdentifiedStructTypeSet::hasType(StructType *Ty) {
1744   if (Ty->isOpaque())
1745     return OpaqueStructTypes.count(Ty);
1746   auto I = NonOpaqueStructTypes.find(Ty);
1747   if (I == NonOpaqueStructTypes.end())
1748     return false;
1749   return *I == Ty;
1750 }
1751
1752 void Linker::init(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
1753   this->Composite = M;
1754   this->DiagnosticHandler = DiagnosticHandler;
1755
1756   TypeFinder StructTypes;
1757   StructTypes.run(*M, true);
1758   for (StructType *Ty : StructTypes) {
1759     if (Ty->isOpaque())
1760       IdentifiedStructTypes.addOpaque(Ty);
1761     else
1762       IdentifiedStructTypes.addNonOpaque(Ty);
1763   }
1764 }
1765
1766 Linker::Linker(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
1767   init(M, DiagnosticHandler);
1768 }
1769
1770 Linker::Linker(Module *M) {
1771   init(M, [this](const DiagnosticInfo &DI) {
1772     Composite->getContext().diagnose(DI);
1773   });
1774 }
1775
1776 void Linker::deleteModule() {
1777   delete Composite;
1778   Composite = nullptr;
1779 }
1780
1781 bool Linker::linkInModule(Module *Src, unsigned Flags) {
1782   ModuleLinker TheLinker(Composite, IdentifiedStructTypes, Src,
1783                          DiagnosticHandler, Flags);
1784   bool RetCode = TheLinker.run();
1785   Composite->dropTriviallyDeadConstantArrays();
1786   return RetCode;
1787 }
1788
1789 void Linker::setModule(Module *Dst) {
1790   init(Dst, DiagnosticHandler);
1791 }
1792
1793 //===----------------------------------------------------------------------===//
1794 // LinkModules entrypoint.
1795 //===----------------------------------------------------------------------===//
1796
1797 /// This function links two modules together, with the resulting Dest module
1798 /// modified to be the composite of the two input modules. If an error occurs,
1799 /// true is returned and ErrorMsg (if not null) is set to indicate the problem.
1800 /// Upon failure, the Dest module could be in a modified state, and shouldn't be
1801 /// relied on to be consistent.
1802 bool Linker::LinkModules(Module *Dest, Module *Src,
1803                          DiagnosticHandlerFunction DiagnosticHandler,
1804                          unsigned Flags) {
1805   Linker L(Dest, DiagnosticHandler);
1806   return L.linkInModule(Src, Flags);
1807 }
1808
1809 bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Flags) {
1810   Linker L(Dest);
1811   return L.linkInModule(Src, Flags);
1812 }
1813
1814 //===----------------------------------------------------------------------===//
1815 // C API.
1816 //===----------------------------------------------------------------------===//
1817
1818 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
1819                          LLVMLinkerMode Unused, char **OutMessages) {
1820   Module *D = unwrap(Dest);
1821   std::string Message;
1822   raw_string_ostream Stream(Message);
1823   DiagnosticPrinterRawOStream DP(Stream);
1824
1825   LLVMBool Result = Linker::LinkModules(
1826       D, unwrap(Src), [&](const DiagnosticInfo &DI) { DI.print(DP); });
1827
1828   if (OutMessages && Result) {
1829     Stream.flush();
1830     *OutMessages = strdup(Message.c_str());
1831   }
1832   return Result;
1833 }