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