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