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