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