lib/Linker/LinkModules.cpp

   1 //===- lib/Linker/LinkModules.cpp - Module Linker Implementation ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the LLVM module linker.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Linker/Linker.h"
  15 #include "llvm-c/Linker.h"
  16 #include "llvm/ADT/Hashing.h"
  17 #include "llvm/ADT/Optional.h"
  18 #include "llvm/ADT/SetVector.h"
  19 #include "llvm/ADT/SmallString.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/ADT/Triple.h"
  22 #include "llvm/IR/Constants.h"
  23 #include "llvm/IR/DebugInfo.h"
  24 #include "llvm/IR/DiagnosticInfo.h"
  25 #include "llvm/IR/DiagnosticPrinter.h"
  26 #include "llvm/IR/LLVMContext.h"
  27 #include "llvm/IR/Module.h"
  28 #include "llvm/IR/TypeFinder.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Transforms/Utils/Cloning.h"
  33 #include <cctype>
  34 #include <tuple>
  35 using namespace llvm;
  36
  37
  38 //===----------------------------------------------------------------------===//
  39 // TypeMap implementation.
  40 //===----------------------------------------------------------------------===//
  41
  42 namespace {
  43 class TypeMapTy : public ValueMapTypeRemapper {
  44   /// This is a mapping from a source type to a destination type to use.
  45   DenseMap<Type*, Type*> MappedTypes;
  46
  47   /// When checking to see if two subgraphs are isomorphic, we speculatively
  48   /// add types to MappedTypes, but keep track of them here in case we need to
  49   /// roll back.
  50   SmallVector<Type*, 16> SpeculativeTypes;
  51
  52   SmallVector<StructType*, 16> SpeculativeDstOpaqueTypes;
  53
  54   /// This is a list of non-opaque structs in the source module that are mapped
  55   /// to an opaque struct in the destination module.
  56   SmallVector<StructType*, 16> SrcDefinitionsToResolve;
  57
  58   /// This is the set of opaque types in the destination modules who are
  59   /// getting a body from the source module.
  60   SmallPtrSet<StructType*, 16> DstResolvedOpaqueTypes;
  61
  62 public:
  63   TypeMapTy(Linker::IdentifiedStructTypeSet &DstStructTypesSet)
  64       : DstStructTypesSet(DstStructTypesSet) {}
  65
  66   Linker::IdentifiedStructTypeSet &DstStructTypesSet;
  67   /// Indicate that the specified type in the destination module is conceptually
  68   /// equivalent to the specified type in the source module.
  69   void addTypeMapping(Type *DstTy, Type *SrcTy);
  70
  71   /// Produce a body for an opaque type in the dest module from a type
  72   /// definition in the source module.
  73   void linkDefinedTypeBodies();
  74
  75   /// Return the mapped type to use for the specified input type from the
  76   /// source module.
  77   Type *get(Type *SrcTy);
  78   Type *get(Type *SrcTy, SmallPtrSet<StructType *, 8> &Visited);
  79
  80   void finishType(StructType *DTy, StructType *STy, ArrayRef<Type *> ETypes);
  81
  82   FunctionType *get(FunctionType *T) {
  83     return cast<FunctionType>(get((Type *)T));
  84   }
  85
  86   /// Dump out the type map for debugging purposes.
  87   void dump() const {
  88     for (auto &Pair : MappedTypes) {
  89       dbgs() << "TypeMap: ";
  90       Pair.first->print(dbgs());
  91       dbgs() << " => ";
  92       Pair.second->print(dbgs());
  93       dbgs() << '\n';
  94     }
  95   }
  96
  97 private:
  98   Type *remapType(Type *SrcTy) override { return get(SrcTy); }
  99
 100   bool areTypesIsomorphic(Type *DstTy, Type *SrcTy);
 101 };
 102 }
 103
 104 void TypeMapTy::addTypeMapping(Type *DstTy, Type *SrcTy) {
 105   assert(SpeculativeTypes.empty());
 106   assert(SpeculativeDstOpaqueTypes.empty());
 107
 108   // Check to see if these types are recursively isomorphic and establish a
 109   // mapping between them if so.
 110   if (!areTypesIsomorphic(DstTy, SrcTy)) {
 111     // Oops, they aren't isomorphic.  Just discard this request by rolling out
 112     // any speculative mappings we've established.
 113     for (Type *Ty : SpeculativeTypes)
 114       MappedTypes.erase(Ty);
 115
 116     SrcDefinitionsToResolve.resize(SrcDefinitionsToResolve.size() -
 117                                    SpeculativeDstOpaqueTypes.size());
 118     for (StructType *Ty : SpeculativeDstOpaqueTypes)
 119       DstResolvedOpaqueTypes.erase(Ty);
 120   } else {
 121     for (Type *Ty : SpeculativeTypes)
 122       if (auto *STy = dyn_cast<StructType>(Ty))
 123         if (STy->hasName())
 124           STy->setName("");
 125   }
 126   SpeculativeTypes.clear();
 127   SpeculativeDstOpaqueTypes.clear();
 128 }
 129
 130 /// Recursively walk this pair of types, returning true if they are isomorphic,
 131 /// false if they are not.
 132 bool TypeMapTy::areTypesIsomorphic(Type *DstTy, Type *SrcTy) {
 133   // Two types with differing kinds are clearly not isomorphic.
 134   if (DstTy->getTypeID() != SrcTy->getTypeID())
 135     return false;
 136
 137   // If we have an entry in the MappedTypes table, then we have our answer.
 138   Type *&Entry = MappedTypes[SrcTy];
 139   if (Entry)
 140     return Entry == DstTy;
 141
 142   // Two identical types are clearly isomorphic.  Remember this
 143   // non-speculatively.
 144   if (DstTy == SrcTy) {
 145     Entry = DstTy;
 146     return true;
 147   }
 148
 149   // Okay, we have two types with identical kinds that we haven't seen before.
 150
 151   // If this is an opaque struct type, special case it.
 152   if (StructType *SSTy = dyn_cast<StructType>(SrcTy)) {
 153     // Mapping an opaque type to any struct, just keep the dest struct.
 154     if (SSTy->isOpaque()) {
 155       Entry = DstTy;
 156       SpeculativeTypes.push_back(SrcTy);
 157       return true;
 158     }
 159
 160     // Mapping a non-opaque source type to an opaque dest.  If this is the first
 161     // type that we're mapping onto this destination type then we succeed.  Keep
 162     // the dest, but fill it in later. If this is the second (different) type
 163     // that we're trying to map onto the same opaque type then we fail.
 164     if (cast<StructType>(DstTy)->isOpaque()) {
 165       // We can only map one source type onto the opaque destination type.
 166       if (!DstResolvedOpaqueTypes.insert(cast<StructType>(DstTy)).second)
 167         return false;
 168       SrcDefinitionsToResolve.push_back(SSTy);
 169       SpeculativeTypes.push_back(SrcTy);
 170       SpeculativeDstOpaqueTypes.push_back(cast<StructType>(DstTy));
 171       Entry = DstTy;
 172       return true;
 173     }
 174   }
 175
 176   // If the number of subtypes disagree between the two types, then we fail.
 177   if (SrcTy->getNumContainedTypes() != DstTy->getNumContainedTypes())
 178     return false;
 179
 180   // Fail if any of the extra properties (e.g. array size) of the type disagree.
 181   if (isa<IntegerType>(DstTy))
 182     return false;  // bitwidth disagrees.
 183   if (PointerType *PT = dyn_cast<PointerType>(DstTy)) {
 184     if (PT->getAddressSpace() != cast<PointerType>(SrcTy)->getAddressSpace())
 185       return false;
 186
 187   } else if (FunctionType *FT = dyn_cast<FunctionType>(DstTy)) {
 188     if (FT->isVarArg() != cast<FunctionType>(SrcTy)->isVarArg())
 189       return false;
 190   } else if (StructType *DSTy = dyn_cast<StructType>(DstTy)) {
 191     StructType *SSTy = cast<StructType>(SrcTy);
 192     if (DSTy->isLiteral() != SSTy->isLiteral() ||
 193         DSTy->isPacked() != SSTy->isPacked())
 194       return false;
 195   } else if (ArrayType *DATy = dyn_cast<ArrayType>(DstTy)) {
 196     if (DATy->getNumElements() != cast<ArrayType>(SrcTy)->getNumElements())
 197       return false;
 198   } else if (VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
 199     if (DVTy->getNumElements() != cast<VectorType>(SrcTy)->getNumElements())
 200       return false;
 201   }
 202
 203   // Otherwise, we speculate that these two types will line up and recursively
 204   // check the subelements.
 205   Entry = DstTy;
 206   SpeculativeTypes.push_back(SrcTy);
 207
 208   for (unsigned I = 0, E = SrcTy->getNumContainedTypes(); I != E; ++I)
 209     if (!areTypesIsomorphic(DstTy->getContainedType(I),
 210                             SrcTy->getContainedType(I)))
 211       return false;
 212
 213   // If everything seems to have lined up, then everything is great.
 214   return true;
 215 }
 216
 217 void TypeMapTy::linkDefinedTypeBodies() {
 218   SmallVector<Type*, 16> Elements;
 219   for (StructType *SrcSTy : SrcDefinitionsToResolve) {
 220     StructType *DstSTy = cast<StructType>(MappedTypes[SrcSTy]);
 221     assert(DstSTy->isOpaque());
 222
 223     // Map the body of the source type over to a new body for the dest type.
 224     Elements.resize(SrcSTy->getNumElements());
 225     for (unsigned I = 0, E = Elements.size(); I != E; ++I)
 226       Elements[I] = get(SrcSTy->getElementType(I));
 227
 228     DstSTy->setBody(Elements, SrcSTy->isPacked());
 229     DstStructTypesSet.switchToNonOpaque(DstSTy);
 230   }
 231   SrcDefinitionsToResolve.clear();
 232   DstResolvedOpaqueTypes.clear();
 233 }
 234
 235 void TypeMapTy::finishType(StructType *DTy, StructType *STy,
 236                            ArrayRef<Type *> ETypes) {
 237   DTy->setBody(ETypes, STy->isPacked());
 238
 239   // Steal STy's name.
 240   if (STy->hasName()) {
 241     SmallString<16> TmpName = STy->getName();
 242     STy->setName("");
 243     DTy->setName(TmpName);
 244   }
 245
 246   DstStructTypesSet.addNonOpaque(DTy);
 247 }
 248
 249 Type *TypeMapTy::get(Type *Ty) {
 250   SmallPtrSet<StructType *, 8> Visited;
 251   return get(Ty, Visited);
 252 }
 253
 254 Type *TypeMapTy::get(Type *Ty, SmallPtrSet<StructType *, 8> &Visited) {
 255   // If we already have an entry for this type, return it.
 256   Type **Entry = &MappedTypes[Ty];
 257   if (*Entry)
 258     return *Entry;
 259
 260   // These are types that LLVM itself will unique.
 261   bool IsUniqued = !isa<StructType>(Ty) || cast<StructType>(Ty)->isLiteral();
 262
 263 #ifndef NDEBUG
 264   if (!IsUniqued) {
 265     for (auto &Pair : MappedTypes) {
 266       assert(!(Pair.first != Ty && Pair.second == Ty) &&
 267              "mapping to a source type");
 268     }
 269   }
 270 #endif
 271
 272   if (!IsUniqued && !Visited.insert(cast<StructType>(Ty)).second) {
 273     StructType *DTy = StructType::create(Ty->getContext());
 274     return *Entry = DTy;
 275   }
 276
 277   // If this is not a recursive type, then just map all of the elements and
 278   // then rebuild the type from inside out.
 279   SmallVector<Type *, 4> ElementTypes;
 280
 281   // If there are no element types to map, then the type is itself.  This is
 282   // true for the anonymous {} struct, things like 'float', integers, etc.
 283   if (Ty->getNumContainedTypes() == 0 && IsUniqued)
 284     return *Entry = Ty;
 285
 286   // Remap all of the elements, keeping track of whether any of them change.
 287   bool AnyChange = false;
 288   ElementTypes.resize(Ty->getNumContainedTypes());
 289   for (unsigned I = 0, E = Ty->getNumContainedTypes(); I != E; ++I) {
 290     ElementTypes[I] = get(Ty->getContainedType(I), Visited);
 291     AnyChange |= ElementTypes[I] != Ty->getContainedType(I);
 292   }
 293
 294   // If we found our type while recursively processing stuff, just use it.
 295   Entry = &MappedTypes[Ty];
 296   if (*Entry) {
 297     if (auto *DTy = dyn_cast<StructType>(*Entry)) {
 298       if (DTy->isOpaque()) {
 299         auto *STy = cast<StructType>(Ty);
 300         finishType(DTy, STy, ElementTypes);
 301       }
 302     }
 303     return *Entry;
 304   }
 305
 306   // If all of the element types mapped directly over and the type is not
 307   // a nomed struct, then the type is usable as-is.
 308   if (!AnyChange && IsUniqued)
 309     return *Entry = Ty;
 310
 311   // Otherwise, rebuild a modified type.
 312   switch (Ty->getTypeID()) {
 313   default:
 314     llvm_unreachable("unknown derived type to remap");
 315   case Type::ArrayTyID:
 316     return *Entry = ArrayType::get(ElementTypes[0],
 317                                    cast<ArrayType>(Ty)->getNumElements());
 318   case Type::VectorTyID:
 319     return *Entry = VectorType::get(ElementTypes[0],
 320                                     cast<VectorType>(Ty)->getNumElements());
 321   case Type::PointerTyID:
 322     return *Entry = PointerType::get(ElementTypes[0],
 323                                      cast<PointerType>(Ty)->getAddressSpace());
 324   case Type::FunctionTyID:
 325     return *Entry = FunctionType::get(ElementTypes[0],
 326                                       makeArrayRef(ElementTypes).slice(1),
 327                                       cast<FunctionType>(Ty)->isVarArg());
 328   case Type::StructTyID: {
 329     auto *STy = cast<StructType>(Ty);
 330     bool IsPacked = STy->isPacked();
 331     if (IsUniqued)
 332       return *Entry = StructType::get(Ty->getContext(), ElementTypes, IsPacked);
 333
 334     // If the type is opaque, we can just use it directly.
 335     if (STy->isOpaque()) {
 336       DstStructTypesSet.addOpaque(STy);
 337       return *Entry = Ty;
 338     }
 339
 340     if (StructType *OldT =
 341             DstStructTypesSet.findNonOpaque(ElementTypes, IsPacked)) {
 342       STy->setName("");
 343       return *Entry = OldT;
 344     }
 345
 346     if (!AnyChange) {
 347       DstStructTypesSet.addNonOpaque(STy);
 348       return *Entry = Ty;
 349     }
 350
 351     StructType *DTy = StructType::create(Ty->getContext());
 352     finishType(DTy, STy, ElementTypes);
 353     return *Entry = DTy;
 354   }
 355   }
 356 }
 357
 358 //===----------------------------------------------------------------------===//
 359 // ModuleLinker implementation.
 360 //===----------------------------------------------------------------------===//
 361
 362 namespace {
 363 class ModuleLinker;
 364
 365 /// Creates prototypes for functions that are lazily linked on the fly. This
 366 /// speeds up linking for modules with many/ lazily linked functions of which
 367 /// few get used.
 368 class ValueMaterializerTy final : public ValueMaterializer {
 369   TypeMapTy &TypeMap;
 370   Module *DstM;
 371   std::vector<GlobalValue *> &LazilyLinkGlobalValues;
 372   ModuleLinker *ModLinker;
 373
 374 public:
 375   ValueMaterializerTy(TypeMapTy &TypeMap, Module *DstM,
 376                       std::vector<GlobalValue *> &LazilyLinkGlobalValues,
 377                       ModuleLinker *ModLinker)
 378       : ValueMaterializer(), TypeMap(TypeMap), DstM(DstM),
 379         LazilyLinkGlobalValues(LazilyLinkGlobalValues), ModLinker(ModLinker) {}
 380
 381   Value *materializeValueFor(Value *V) override;
 382 };
 383
 384 class LinkDiagnosticInfo : public DiagnosticInfo {
 385   const Twine &Msg;
 386
 387 public:
 388   LinkDiagnosticInfo(DiagnosticSeverity Severity, const Twine &Msg);
 389   void print(DiagnosticPrinter &DP) const override;
 390 };
 391 LinkDiagnosticInfo::LinkDiagnosticInfo(DiagnosticSeverity Severity,
 392                                        const Twine &Msg)
 393     : DiagnosticInfo(DK_Linker, Severity), Msg(Msg) {}
 394 void LinkDiagnosticInfo::print(DiagnosticPrinter &DP) const { DP << Msg; }
 395
 396 /// This is an implementation class for the LinkModules function, which is the
 397 /// entrypoint for this file.
 398 class ModuleLinker {
 399   Module *DstM, *SrcM;
 400
 401   TypeMapTy TypeMap;
 402   ValueMaterializerTy ValMaterializer;
 403
 404   /// Mapping of values from what they used to be in Src, to what they are now
 405   /// in DstM.  ValueToValueMapTy is a ValueMap, which involves some overhead
 406   /// due to the use of Value handles which the Linker doesn't actually need,
 407   /// but this allows us to reuse the ValueMapper code.
 408   ValueToValueMapTy ValueMap;
 409
 410   struct AppendingVarInfo {
 411     GlobalVariable *NewGV;   // New aggregate global in dest module.
 412     const Constant *DstInit; // Old initializer from dest module.
 413     const Constant *SrcInit; // Old initializer from src module.
 414   };
 415
 416   std::vector<AppendingVarInfo> AppendingVars;
 417
 418   // Set of items not to link in from source.
 419   SmallPtrSet<const Value *, 16> DoNotLinkFromSource;
 420
 421   // Vector of GlobalValues to lazily link in.
 422   std::vector<GlobalValue *> LazilyLinkGlobalValues;
 423
 424   DiagnosticHandlerFunction DiagnosticHandler;
 425
 426   /// For symbol clashes, prefer those from Src.
 427   unsigned Flags;
 428
 429   /// Function index passed into ModuleLinker for using in function
 430   /// importing/exporting handling.
 431   FunctionInfoIndex *ImportIndex;
 432
 433   /// Function to import from source module, all other functions are
 434   /// imported as declarations instead of definitions.
 435   Function *ImportFunction;
 436
 437   /// Set to true if the given FunctionInfoIndex contains any functions
 438   /// from this source module, in which case we must conservatively assume
 439   /// that any of its functions may be imported into another module
 440   /// as part of a different backend compilation process.
 441   bool HasExportedFunctions;
 442
 443   /// Set to true when all global value body linking is complete (including
 444   /// lazy linking). Used to prevent metadata linking from creating new
 445   /// references.
 446   bool DoneLinkingBodies;
 447
 448 public:
 449   ModuleLinker(Module *dstM, Linker::IdentifiedStructTypeSet &Set, Module *srcM,
 450                DiagnosticHandlerFunction DiagnosticHandler, unsigned Flags,
 451                FunctionInfoIndex *Index = nullptr,
 452                Function *FuncToImport = nullptr)
 453       : DstM(dstM), SrcM(srcM), TypeMap(Set),
 454         ValMaterializer(TypeMap, DstM, LazilyLinkGlobalValues, this),
 455         DiagnosticHandler(DiagnosticHandler), Flags(Flags), ImportIndex(Index),
 456         ImportFunction(FuncToImport), HasExportedFunctions(false),
 457         DoneLinkingBodies(false) {
 458     assert((ImportIndex || !ImportFunction) &&
 459            "Expect a FunctionInfoIndex when importing");
 460     // If we have a FunctionInfoIndex but no function to import,
 461     // then this is the primary module being compiled in a ThinLTO
 462     // backend compilation, and we need to see if it has functions that
 463     // may be exported to another backend compilation.
 464     if (ImportIndex && !ImportFunction)
 465       HasExportedFunctions = ImportIndex->hasExportedFunctions(SrcM);
 466   }
 467
 468   bool run();
 469
 470   bool shouldOverrideFromSrc() { return Flags & Linker::OverrideFromSrc; }
 471   bool shouldLinkOnlyNeeded() { return Flags & Linker::LinkOnlyNeeded; }
 472   bool shouldInternalizeLinkedSymbols() {
 473     return Flags & Linker::InternalizeLinkedSymbols;
 474   }
 475
 476   /// Handles cloning of a global values from the source module into
 477   /// the destination module, including setting the attributes and visibility.
 478   GlobalValue *copyGlobalValueProto(TypeMapTy &TypeMap, const GlobalValue *SGV,
 479                                     const GlobalValue *DGV = nullptr);
 480
 481   /// Check if we should promote the given local value to global scope.
 482   bool doPromoteLocalToGlobal(const GlobalValue *SGV);
 483
 484   /// Check if all global value body linking is complete.
 485   bool doneLinkingBodies() { return DoneLinkingBodies; }
 486
 487 private:
 488   bool shouldLinkFromSource(bool &LinkFromSrc, const GlobalValue &Dest,
 489                             const GlobalValue &Src);
 490
 491   /// Helper method for setting a message and returning an error code.
 492   bool emitError(const Twine &Message) {
 493     DiagnosticHandler(LinkDiagnosticInfo(DS_Error, Message));
 494     return true;
 495   }
 496
 497   void emitWarning(const Twine &Message) {
 498     DiagnosticHandler(LinkDiagnosticInfo(DS_Warning, Message));
 499   }
 500
 501   bool getComdatLeader(Module *M, StringRef ComdatName,
 502                        const GlobalVariable *&GVar);
 503   bool computeResultingSelectionKind(StringRef ComdatName,
 504                                      Comdat::SelectionKind Src,
 505                                      Comdat::SelectionKind Dst,
 506                                      Comdat::SelectionKind &Result,
 507                                      bool &LinkFromSrc);
 508   std::map<const Comdat *, std::pair<Comdat::SelectionKind, bool>>
 509       ComdatsChosen;
 510   bool getComdatResult(const Comdat *SrcC, Comdat::SelectionKind &SK,
 511                        bool &LinkFromSrc);
 512
 513   /// Given a global in the source module, return the global in the
 514   /// destination module that is being linked to, if any.
 515   GlobalValue *getLinkedToGlobal(const GlobalValue *SrcGV) {
 516     // If the source has no name it can't link.  If it has local linkage,
 517     // there is no name match-up going on.
 518     if (!SrcGV->hasName() || SrcGV->hasLocalLinkage())
 519       return nullptr;
 520
 521     // Otherwise see if we have a match in the destination module's symtab.
 522     GlobalValue *DGV = DstM->getNamedValue(SrcGV->getName());
 523     if (!DGV)
 524       return nullptr;
 525
 526     // If we found a global with the same name in the dest module, but it has
 527     // internal linkage, we are really not doing any linkage here.
 528     if (DGV->hasLocalLinkage())
 529       return nullptr;
 530
 531     // Otherwise, we do in fact link to the destination global.
 532     return DGV;
 533   }
 534
 535   void computeTypeMapping();
 536
 537   void upgradeMismatchedGlobalArray(StringRef Name);
 538   void upgradeMismatchedGlobals();
 539
 540   bool linkAppendingVarProto(GlobalVariable *DstGV,
 541                              const GlobalVariable *SrcGV);
 542
 543   bool linkGlobalValueProto(GlobalValue *GV);
 544   bool linkModuleFlagsMetadata();
 545
 546   void linkAppendingVarInit(const AppendingVarInfo &AVI);
 547
 548   void linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src);
 549   bool linkFunctionBody(Function &Dst, Function &Src);
 550   void linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src);
 551   bool linkGlobalValueBody(GlobalValue &Src);
 552
 553   /// Functions that take care of cloning a specific global value type
 554   /// into the destination module.
 555   GlobalVariable *copyGlobalVariableProto(TypeMapTy &TypeMap,
 556                                           const GlobalVariable *SGVar);
 557   Function *copyFunctionProto(TypeMapTy &TypeMap, const Function *SF);
 558   GlobalValue *copyGlobalAliasProto(TypeMapTy &TypeMap, const GlobalAlias *SGA);
 559
 560   /// Helper methods to check if we are importing from or potentially
 561   /// exporting from the current source module.
 562   bool isPerformingImport() { return ImportFunction != nullptr; }
 563   bool isModuleExporting() { return HasExportedFunctions; }
 564
 565   /// If we are importing from the source module, checks if we should
 566   /// import SGV as a definition, otherwise import as a declaration.
 567   bool doImportAsDefinition(const GlobalValue *SGV);
 568
 569   /// Get the name for SGV that should be used in the linked destination
 570   /// module. Specifically, this handles the case where we need to rename
 571   /// a local that is being promoted to global scope.
 572   std::string getName(const GlobalValue *SGV);
 573
 574   /// Get the new linkage for SGV that should be used in the linked destination
 575   /// module. Specifically, for ThinLTO importing or exporting it may need
 576   /// to be adjusted.
 577   GlobalValue::LinkageTypes getLinkage(const GlobalValue *SGV);
 578
 579   /// Copies the necessary global value attributes and name from the source
 580   /// to the newly cloned global value.
 581   void copyGVAttributes(GlobalValue *NewGV, const GlobalValue *SrcGV);
 582
 583   /// Updates the visibility for the new global cloned from the source
 584   /// and, if applicable, linked with an existing destination global.
 585   /// Handles visibility change required for promoted locals.
 586   void setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
 587                      const GlobalValue *DGV = nullptr);
 588
 589   void linkNamedMDNodes();
 590 };
 591 }
 592
 593 /// The LLVM SymbolTable class autorenames globals that conflict in the symbol
 594 /// table. This is good for all clients except for us. Go through the trouble
 595 /// to force this back.
 596 static void forceRenaming(GlobalValue *GV, StringRef Name) {
 597   // If the global doesn't force its name or if it already has the right name,
 598   // there is nothing for us to do.
 599   // Note that any required local to global promotion should already be done,
 600   // so promoted locals will not skip this handling as their linkage is no
 601   // longer local.
 602   if (GV->hasLocalLinkage() || GV->getName() == Name)
 603     return;
 604
 605   Module *M = GV->getParent();
 606
 607   // If there is a conflict, rename the conflict.
 608   if (GlobalValue *ConflictGV = M->getNamedValue(Name)) {
 609     GV->takeName(ConflictGV);
 610     ConflictGV->setName(Name);    // This will cause ConflictGV to get renamed
 611     assert(ConflictGV->getName() != Name && "forceRenaming didn't work");
 612   } else {
 613     GV->setName(Name);              // Force the name back
 614   }
 615 }
 616
 617 /// copy additional attributes (those not needed to construct a GlobalValue)
 618 /// from the SrcGV to the DestGV.
 619 void ModuleLinker::copyGVAttributes(GlobalValue *NewGV,
 620                                     const GlobalValue *SrcGV) {
 621   auto *GA = dyn_cast<GlobalAlias>(SrcGV);
 622   // Check for the special case of converting an alias (definition) to a
 623   // non-alias (declaration). This can happen when we are importing and
 624   // encounter a weak_any alias (weak_any defs may not be imported, see
 625   // comments in ModuleLinker::getLinkage) or an alias whose base object is
 626   // being imported as a declaration. In that case copy the attributes from the
 627   // base object.
 628   if (GA && !dyn_cast<GlobalAlias>(NewGV)) {
 629     assert(isPerformingImport() &&
 630            (GA->hasWeakAnyLinkage() ||
 631             !doImportAsDefinition(GA->getBaseObject())));
 632     NewGV->copyAttributesFrom(GA->getBaseObject());
 633   } else
 634     NewGV->copyAttributesFrom(SrcGV);
 635   forceRenaming(NewGV, getName(SrcGV));
 636 }
 637
 638 static bool isLessConstraining(GlobalValue::VisibilityTypes a,
 639                                GlobalValue::VisibilityTypes b) {
 640   if (a == GlobalValue::HiddenVisibility)
 641     return false;
 642   if (b == GlobalValue::HiddenVisibility)
 643     return true;
 644   if (a == GlobalValue::ProtectedVisibility)
 645     return false;
 646   if (b == GlobalValue::ProtectedVisibility)
 647     return true;
 648   return false;
 649 }
 650
 651 bool ModuleLinker::doImportAsDefinition(const GlobalValue *SGV) {
 652   if (!isPerformingImport())
 653     return false;
 654   // Always import GlobalVariable definitions. The linkage changes
 655   // described in ModuleLinker::getLinkage ensure the correct behavior (e.g.
 656   // global variables with external linkage are transformed to
 657   // available_externally defintions, which are ultimately turned into
 658   // declaratios after the EliminateAvailableExternally pass).
 659   if (dyn_cast<GlobalVariable>(SGV) && !SGV->isDeclaration())
 660     return true;
 661   // Only import the function requested for importing.
 662   auto *SF = dyn_cast<Function>(SGV);
 663   if (SF && SF == ImportFunction)
 664     return true;
 665   // Otherwise no.
 666   return false;
 667 }
 668
 669 bool ModuleLinker::doPromoteLocalToGlobal(const GlobalValue *SGV) {
 670   assert(SGV->hasLocalLinkage());
 671   // Both the imported references and the original local variable must
 672   // be promoted.
 673   if (!isPerformingImport() && !isModuleExporting())
 674     return false;
 675
 676   // Local const variables never need to be promoted unless they are address
 677   // taken. The imported uses can simply use the clone created in this module.
 678   // For now we are conservative in determining which variables are not
 679   // address taken by checking the unnamed addr flag. To be more aggressive,
 680   // the address taken information must be checked earlier during parsing
 681   // of the module and recorded in the function index for use when importing
 682   // from that module.
 683   auto *GVar = dyn_cast<GlobalVariable>(SGV);
 684   if (GVar && GVar->isConstant() && GVar->hasUnnamedAddr())
 685     return false;
 686
 687   // Eventually we only need to promote functions in the exporting module that
 688   // are referenced by a potentially exported function (i.e. one that is in the
 689   // function index).
 690   return true;
 691 }
 692
 693 std::string ModuleLinker::getName(const GlobalValue *SGV) {
 694   // For locals that must be promoted to global scope, ensure that
 695   // the promoted name uniquely identifies the copy in the original module,
 696   // using the ID assigned during combined index creation. When importing,
 697   // we rename all locals (not just those that are promoted) in order to
 698   // avoid naming conflicts between locals imported from different modules.
 699   if (SGV->hasLocalLinkage() &&
 700       (doPromoteLocalToGlobal(SGV) || isPerformingImport()))
 701     return FunctionInfoIndex::getGlobalNameForLocal(
 702         SGV->getName(),
 703         ImportIndex->getModuleId(SGV->getParent()->getModuleIdentifier()));
 704   return SGV->getName();
 705 }
 706
 707 GlobalValue::LinkageTypes ModuleLinker::getLinkage(const GlobalValue *SGV) {
 708   // Any local variable that is referenced by an exported function needs
 709   // to be promoted to global scope. Since we don't currently know which
 710   // functions reference which local variables/functions, we must treat
 711   // all as potentially exported if this module is exporting anything.
 712   if (isModuleExporting()) {
 713     if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
 714       return GlobalValue::ExternalLinkage;
 715     return SGV->getLinkage();
 716   }
 717
 718   // Otherwise, if we aren't importing, no linkage change is needed.
 719   if (!isPerformingImport())
 720     return SGV->getLinkage();
 721
 722   switch (SGV->getLinkage()) {
 723   case GlobalValue::ExternalLinkage:
 724     // External defnitions are converted to available_externally
 725     // definitions upon import, so that they are available for inlining
 726     // and/or optimization, but are turned into declarations later
 727     // during the EliminateAvailableExternally pass.
 728     if (doImportAsDefinition(SGV))
 729       return GlobalValue::AvailableExternallyLinkage;
 730     // An imported external declaration stays external.
 731     return SGV->getLinkage();
 732
 733   case GlobalValue::AvailableExternallyLinkage:
 734     // An imported available_externally definition converts
 735     // to external if imported as a declaration.
 736     if (!doImportAsDefinition(SGV))
 737       return GlobalValue::ExternalLinkage;
 738     // An imported available_externally declaration stays that way.
 739     return SGV->getLinkage();
 740
 741   case GlobalValue::LinkOnceAnyLinkage:
 742   case GlobalValue::LinkOnceODRLinkage:
 743     // These both stay the same when importing the definition.
 744     // The ThinLTO pass will eventually force-import their definitions.
 745     return SGV->getLinkage();
 746
 747   case GlobalValue::WeakAnyLinkage:
 748     // Can't import weak_any definitions correctly, or we might change the
 749     // program semantics, since the linker will pick the first weak_any
 750     // definition and importing would change the order they are seen by the
 751     // linker. The module linking caller needs to enforce this.
 752     assert(!doImportAsDefinition(SGV));
 753     // If imported as a declaration, it becomes external_weak.
 754     return GlobalValue::ExternalWeakLinkage;
 755
 756   case GlobalValue::WeakODRLinkage:
 757     // For weak_odr linkage, there is a guarantee that all copies will be
 758     // equivalent, so the issue described above for weak_any does not exist,
 759     // and the definition can be imported. It can be treated similarly
 760     // to an imported externally visible global value.
 761     if (doImportAsDefinition(SGV))
 762       return GlobalValue::AvailableExternallyLinkage;
 763     else
 764       return GlobalValue::ExternalLinkage;
 765
 766   case GlobalValue::AppendingLinkage:
 767     // It would be incorrect to import an appending linkage variable,
 768     // since it would cause global constructors/destructors to be
 769     // executed multiple times. This should have already been handled
 770     // by linkGlobalValueProto.
 771     assert(false && "Cannot import appending linkage variable");
 772
 773   case GlobalValue::InternalLinkage:
 774   case GlobalValue::PrivateLinkage:
 775     // If we are promoting the local to global scope, it is handled
 776     // similarly to a normal externally visible global.
 777     if (doPromoteLocalToGlobal(SGV)) {
 778       if (doImportAsDefinition(SGV))
 779         return GlobalValue::AvailableExternallyLinkage;
 780       else
 781         return GlobalValue::ExternalLinkage;
 782     }
 783     // A non-promoted imported local definition stays local.
 784     // The ThinLTO pass will eventually force-import their definitions.
 785     return SGV->getLinkage();
 786
 787   case GlobalValue::ExternalWeakLinkage:
 788     // External weak doesn't apply to definitions, must be a declaration.
 789     assert(!doImportAsDefinition(SGV));
 790     // Linkage stays external_weak.
 791     return SGV->getLinkage();
 792
 793   case GlobalValue::CommonLinkage:
 794     // Linkage stays common on definitions.
 795     // The ThinLTO pass will eventually force-import their definitions.
 796     return SGV->getLinkage();
 797   }
 798
 799   llvm_unreachable("unknown linkage type");
 800 }
 801
 802 /// Loop through the global variables in the src module and merge them into the
 803 /// dest module.
 804 GlobalVariable *
 805 ModuleLinker::copyGlobalVariableProto(TypeMapTy &TypeMap,
 806                                       const GlobalVariable *SGVar) {
 807   // No linking to be performed or linking from the source: simply create an
 808   // identical version of the symbol over in the dest module... the
 809   // initializer will be filled in later by LinkGlobalInits.
 810   GlobalVariable *NewDGV = new GlobalVariable(
 811       *DstM, TypeMap.get(SGVar->getType()->getElementType()),
 812       SGVar->isConstant(), getLinkage(SGVar), /*init*/ nullptr, getName(SGVar),
 813       /*insertbefore*/ nullptr, SGVar->getThreadLocalMode(),
 814       SGVar->getType()->getAddressSpace());
 815
 816   return NewDGV;
 817 }
 818
 819 /// Link the function in the source module into the destination module if
 820 /// needed, setting up mapping information.
 821 Function *ModuleLinker::copyFunctionProto(TypeMapTy &TypeMap,
 822                                           const Function *SF) {
 823   // If there is no linkage to be performed or we are linking from the source,
 824   // bring SF over.
 825   return Function::Create(TypeMap.get(SF->getFunctionType()), getLinkage(SF),
 826                           getName(SF), DstM);
 827 }
 828
 829 /// Set up prototypes for any aliases that come over from the source module.
 830 GlobalValue *ModuleLinker::copyGlobalAliasProto(TypeMapTy &TypeMap,
 831                                                 const GlobalAlias *SGA) {
 832   // If we are importing and encounter a weak_any alias, or an alias to
 833   // an object being imported as a declaration, we must import the alias
 834   // as a declaration as well, which involves converting it to a non-alias.
 835   // See comments in ModuleLinker::getLinkage for why we cannot import
 836   // weak_any defintions.
 837   if (isPerformingImport() && (SGA->hasWeakAnyLinkage() ||
 838                                !doImportAsDefinition(SGA->getBaseObject()))) {
 839     // Need to convert to declaration. All aliases must be definitions.
 840     const GlobalValue *GVal = SGA->getBaseObject();
 841     GlobalValue *NewGV;
 842     if (auto *GVar = dyn_cast<GlobalVariable>(GVal))
 843       NewGV = copyGlobalVariableProto(TypeMap, GVar);
 844     else {
 845       auto *F = dyn_cast<Function>(GVal);
 846       assert(F);
 847       NewGV = copyFunctionProto(TypeMap, F);
 848     }
 849     // Set the linkage to External or ExternalWeak (see comments in
 850     // ModuleLinker::getLinkage for why WeakAny is converted to ExternalWeak).
 851     if (SGA->hasWeakAnyLinkage())
 852       NewGV->setLinkage(GlobalValue::ExternalWeakLinkage);
 853     else
 854       NewGV->setLinkage(GlobalValue::ExternalLinkage);
 855     // Don't attempt to link body, needs to be a declaration.
 856     DoNotLinkFromSource.insert(SGA);
 857     return NewGV;
 858   }
 859   // If there is no linkage to be performed or we're linking from the source,
 860   // bring over SGA.
 861   auto *Ty = TypeMap.get(SGA->getValueType());
 862   return GlobalAlias::create(Ty, SGA->getType()->getPointerAddressSpace(),
 863                              getLinkage(SGA), getName(SGA), DstM);
 864 }
 865
 866 void ModuleLinker::setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
 867                                  const GlobalValue *DGV) {
 868   GlobalValue::VisibilityTypes Visibility = SGV->getVisibility();
 869   if (DGV)
 870     Visibility = isLessConstraining(Visibility, DGV->getVisibility())
 871                      ? DGV->getVisibility()
 872                      : Visibility;
 873   // For promoted locals, mark them hidden so that they can later be
 874   // stripped from the symbol table to reduce bloat.
 875   if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
 876     Visibility = GlobalValue::HiddenVisibility;
 877   NewGV->setVisibility(Visibility);
 878 }
 879
 880 GlobalValue *ModuleLinker::copyGlobalValueProto(TypeMapTy &TypeMap,
 881                                                 const GlobalValue *SGV,
 882                                                 const GlobalValue *DGV) {
 883   GlobalValue *NewGV;
 884   if (auto *SGVar = dyn_cast<GlobalVariable>(SGV))
 885     NewGV = copyGlobalVariableProto(TypeMap, SGVar);
 886   else if (auto *SF = dyn_cast<Function>(SGV))
 887     NewGV = copyFunctionProto(TypeMap, SF);
 888   else
 889     NewGV = copyGlobalAliasProto(TypeMap, cast<GlobalAlias>(SGV));
 890   copyGVAttributes(NewGV, SGV);
 891   setVisibility(NewGV, SGV, DGV);
 892   return NewGV;
 893 }
 894
 895 Value *ValueMaterializerTy::materializeValueFor(Value *V) {
 896   auto *SGV = dyn_cast<GlobalValue>(V);
 897   if (!SGV)
 898     return nullptr;
 899
 900   // If we are done linking global value bodies (i.e. we are performing
 901   // metadata linking), don't link in the global value due to this
 902   // reference, simply map it to null.
 903   if (ModLinker->doneLinkingBodies())
 904     return nullptr;
 905
 906   GlobalValue *DGV = ModLinker->copyGlobalValueProto(TypeMap, SGV);
 907
 908   if (Comdat *SC = SGV->getComdat()) {
 909     if (auto *DGO = dyn_cast<GlobalObject>(DGV)) {
 910       Comdat *DC = DstM->getOrInsertComdat(SC->getName());
 911       DGO->setComdat(DC);
 912     }
 913   }
 914
 915   LazilyLinkGlobalValues.push_back(SGV);
 916   return DGV;
 917 }
 918
 919 bool ModuleLinker::getComdatLeader(Module *M, StringRef ComdatName,
 920                                    const GlobalVariable *&GVar) {
 921   const GlobalValue *GVal = M->getNamedValue(ComdatName);
 922   if (const auto *GA = dyn_cast_or_null<GlobalAlias>(GVal)) {
 923     GVal = GA->getBaseObject();
 924     if (!GVal)
 925       // We cannot resolve the size of the aliasee yet.
 926       return emitError("Linking COMDATs named '" + ComdatName +
 927                        "': COMDAT key involves incomputable alias size.");
 928   }
 929
 930   GVar = dyn_cast_or_null<GlobalVariable>(GVal);
 931   if (!GVar)
 932     return emitError(
 933         "Linking COMDATs named '" + ComdatName +
 934         "': GlobalVariable required for data dependent selection!");
 935
 936   return false;
 937 }
 938
 939 bool ModuleLinker::computeResultingSelectionKind(StringRef ComdatName,
 940                                                  Comdat::SelectionKind Src,
 941                                                  Comdat::SelectionKind Dst,
 942                                                  Comdat::SelectionKind &Result,
 943                                                  bool &LinkFromSrc) {
 944   // The ability to mix Comdat::SelectionKind::Any with
 945   // Comdat::SelectionKind::Largest is a behavior that comes from COFF.
 946   bool DstAnyOrLargest = Dst == Comdat::SelectionKind::Any ||
 947                          Dst == Comdat::SelectionKind::Largest;
 948   bool SrcAnyOrLargest = Src == Comdat::SelectionKind::Any ||
 949                          Src == Comdat::SelectionKind::Largest;
 950   if (DstAnyOrLargest && SrcAnyOrLargest) {
 951     if (Dst == Comdat::SelectionKind::Largest ||
 952         Src == Comdat::SelectionKind::Largest)
 953       Result = Comdat::SelectionKind::Largest;
 954     else
 955       Result = Comdat::SelectionKind::Any;
 956   } else if (Src == Dst) {
 957     Result = Dst;
 958   } else {
 959     return emitError("Linking COMDATs named '" + ComdatName +
 960                      "': invalid selection kinds!");
 961   }
 962
 963   switch (Result) {
 964   case Comdat::SelectionKind::Any:
 965     // Go with Dst.
 966     LinkFromSrc = false;
 967     break;
 968   case Comdat::SelectionKind::NoDuplicates:
 969     return emitError("Linking COMDATs named '" + ComdatName +
 970                      "': noduplicates has been violated!");
 971   case Comdat::SelectionKind::ExactMatch:
 972   case Comdat::SelectionKind::Largest:
 973   case Comdat::SelectionKind::SameSize: {
 974     const GlobalVariable *DstGV;
 975     const GlobalVariable *SrcGV;
 976     if (getComdatLeader(DstM, ComdatName, DstGV) ||
 977         getComdatLeader(SrcM, ComdatName, SrcGV))
 978       return true;
 979
 980     const DataLayout &DstDL = DstM->getDataLayout();
 981     const DataLayout &SrcDL = SrcM->getDataLayout();
 982     uint64_t DstSize =
 983         DstDL.getTypeAllocSize(DstGV->getType()->getPointerElementType());
 984     uint64_t SrcSize =
 985         SrcDL.getTypeAllocSize(SrcGV->getType()->getPointerElementType());
 986     if (Result == Comdat::SelectionKind::ExactMatch) {
 987       if (SrcGV->getInitializer() != DstGV->getInitializer())
 988         return emitError("Linking COMDATs named '" + ComdatName +
 989                          "': ExactMatch violated!");
 990       LinkFromSrc = false;
 991     } else if (Result == Comdat::SelectionKind::Largest) {
 992       LinkFromSrc = SrcSize > DstSize;
 993     } else if (Result == Comdat::SelectionKind::SameSize) {
 994       if (SrcSize != DstSize)
 995         return emitError("Linking COMDATs named '" + ComdatName +
 996                          "': SameSize violated!");
 997       LinkFromSrc = false;
 998     } else {
 999       llvm_unreachable("unknown selection kind");
1000     }
1001     break;
1002   }
1003   }
1004
1005   return false;
1006 }
1007
1008 bool ModuleLinker::getComdatResult(const Comdat *SrcC,
1009                                    Comdat::SelectionKind &Result,
1010                                    bool &LinkFromSrc) {
1011   Comdat::SelectionKind SSK = SrcC->getSelectionKind();
1012   StringRef ComdatName = SrcC->getName();
1013   Module::ComdatSymTabType &ComdatSymTab = DstM->getComdatSymbolTable();
1014   Module::ComdatSymTabType::iterator DstCI = ComdatSymTab.find(ComdatName);
1015
1016   if (DstCI == ComdatSymTab.end()) {
1017     // Use the comdat if it is only available in one of the modules.
1018     LinkFromSrc = true;
1019     Result = SSK;
1020     return false;
1021   }
1022
1023   const Comdat *DstC = &DstCI->second;
1024   Comdat::SelectionKind DSK = DstC->getSelectionKind();
1025   return computeResultingSelectionKind(ComdatName, SSK, DSK, Result,
1026                                        LinkFromSrc);
1027 }
1028
1029 bool ModuleLinker::shouldLinkFromSource(bool &LinkFromSrc,
1030                                         const GlobalValue &Dest,
1031                                         const GlobalValue &Src) {
1032   // Should we unconditionally use the Src?
1033   if (shouldOverrideFromSrc()) {
1034     LinkFromSrc = true;
1035     return false;
1036   }
1037
1038   // We always have to add Src if it has appending linkage.
1039   if (Src.hasAppendingLinkage()) {
1040     // Caller should have already determined that we can't link from source
1041     // when importing (see comments in linkGlobalValueProto).
1042     assert(!isPerformingImport());
1043     LinkFromSrc = true;
1044     return false;
1045   }
1046
1047   bool SrcIsDeclaration = Src.isDeclarationForLinker();
1048   bool DestIsDeclaration = Dest.isDeclarationForLinker();
1049
1050   if (isPerformingImport()) {
1051     if (isa<Function>(&Src)) {
1052       // For functions, LinkFromSrc iff this is the function requested
1053       // for importing. For variables, decide below normally.
1054       LinkFromSrc = (&Src == ImportFunction);
1055       return false;
1056     }
1057
1058     // Check if this is an alias with an already existing definition
1059     // in Dest, which must have come from a prior importing pass from
1060     // the same Src module. Unlike imported function and variable
1061     // definitions, which are imported as available_externally and are
1062     // not definitions for the linker, that is not a valid linkage for
1063     // imported aliases which must be definitions. Simply use the existing
1064     // Dest copy.
1065     if (isa<GlobalAlias>(&Src) && !DestIsDeclaration) {
1066       assert(isa<GlobalAlias>(&Dest));
1067       LinkFromSrc = false;
1068       return false;
1069     }
1070   }
1071
1072   if (SrcIsDeclaration) {
1073     // If Src is external or if both Src & Dest are external..  Just link the
1074     // external globals, we aren't adding anything.
1075     if (Src.hasDLLImportStorageClass()) {
1076       // If one of GVs is marked as DLLImport, result should be dllimport'ed.
1077       LinkFromSrc = DestIsDeclaration;
1078       return false;
1079     }
1080     // If the Dest is weak, use the source linkage.
1081     LinkFromSrc = Dest.hasExternalWeakLinkage();
1082     return false;
1083   }
1084
1085   if (DestIsDeclaration) {
1086     // If Dest is external but Src is not:
1087     LinkFromSrc = true;
1088     return false;
1089   }
1090
1091   if (Src.hasCommonLinkage()) {
1092     if (Dest.hasLinkOnceLinkage() || Dest.hasWeakLinkage()) {
1093       LinkFromSrc = true;
1094       return false;
1095     }
1096
1097     if (!Dest.hasCommonLinkage()) {
1098       LinkFromSrc = false;
1099       return false;
1100     }
1101
1102     const DataLayout &DL = Dest.getParent()->getDataLayout();
1103     uint64_t DestSize = DL.getTypeAllocSize(Dest.getType()->getElementType());
1104     uint64_t SrcSize = DL.getTypeAllocSize(Src.getType()->getElementType());
1105     LinkFromSrc = SrcSize > DestSize;
1106     return false;
1107   }
1108
1109   if (Src.isWeakForLinker()) {
1110     assert(!Dest.hasExternalWeakLinkage());
1111     assert(!Dest.hasAvailableExternallyLinkage());
1112
1113     if (Dest.hasLinkOnceLinkage() && Src.hasWeakLinkage()) {
1114       LinkFromSrc = true;
1115       return false;
1116     }
1117
1118     LinkFromSrc = false;
1119     return false;
1120   }
1121
1122   if (Dest.isWeakForLinker()) {
1123     assert(Src.hasExternalLinkage());
1124     LinkFromSrc = true;
1125     return false;
1126   }
1127
1128   assert(!Src.hasExternalWeakLinkage());
1129   assert(!Dest.hasExternalWeakLinkage());
1130   assert(Dest.hasExternalLinkage() && Src.hasExternalLinkage() &&
1131          "Unexpected linkage type!");
1132   return emitError("Linking globals named '" + Src.getName() +
1133                    "': symbol multiply defined!");
1134 }
1135
1136 /// Loop over all of the linked values to compute type mappings.  For example,
1137 /// if we link "extern Foo *x" and "Foo *x = NULL", then we have two struct
1138 /// types 'Foo' but one got renamed when the module was loaded into the same
1139 /// LLVMContext.
1140 void ModuleLinker::computeTypeMapping() {
1141   for (GlobalValue &SGV : SrcM->globals()) {
1142     GlobalValue *DGV = getLinkedToGlobal(&SGV);
1143     if (!DGV)
1144       continue;
1145
1146     if (!DGV->hasAppendingLinkage() || !SGV.hasAppendingLinkage()) {
1147       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1148       continue;
1149     }
1150
1151     // Unify the element type of appending arrays.
1152     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
1153     ArrayType *SAT = cast<ArrayType>(SGV.getType()->getElementType());
1154     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
1155   }
1156
1157   for (GlobalValue &SGV : *SrcM) {
1158     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
1159       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1160   }
1161
1162   for (GlobalValue &SGV : SrcM->aliases()) {
1163     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
1164       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1165   }
1166
1167   // Incorporate types by name, scanning all the types in the source module.
1168   // At this point, the destination module may have a type "%foo = { i32 }" for
1169   // example.  When the source module got loaded into the same LLVMContext, if
1170   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
1171   std::vector<StructType *> Types = SrcM->getIdentifiedStructTypes();
1172   for (StructType *ST : Types) {
1173     if (!ST->hasName())
1174       continue;
1175
1176     // Check to see if there is a dot in the name followed by a digit.
1177     size_t DotPos = ST->getName().rfind('.');
1178     if (DotPos == 0 || DotPos == StringRef::npos ||
1179         ST->getName().back() == '.' ||
1180         !isdigit(static_cast<unsigned char>(ST->getName()[DotPos + 1])))
1181       continue;
1182
1183     // Check to see if the destination module has a struct with the prefix name.
1184     StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos));
1185     if (!DST)
1186       continue;
1187
1188     // Don't use it if this actually came from the source module. They're in
1189     // the same LLVMContext after all. Also don't use it unless the type is
1190     // actually used in the destination module. This can happen in situations
1191     // like this:
1192     //
1193     //      Module A                         Module B
1194     //      --------                         --------
1195     //   %Z = type { %A }                %B = type { %C.1 }
1196     //   %A = type { %B.1, [7 x i8] }    %C.1 = type { i8* }
1197     //   %B.1 = type { %C }              %A.2 = type { %B.3, [5 x i8] }
1198     //   %C = type { i8* }               %B.3 = type { %C.1 }
1199     //
1200     // When we link Module B with Module A, the '%B' in Module B is
1201     // used. However, that would then use '%C.1'. But when we process '%C.1',
1202     // we prefer to take the '%C' version. So we are then left with both
1203     // '%C.1' and '%C' being used for the same types. This leads to some
1204     // variables using one type and some using the other.
1205     if (TypeMap.DstStructTypesSet.hasType(DST))
1206       TypeMap.addTypeMapping(DST, ST);
1207   }
1208
1209   // Now that we have discovered all of the type equivalences, get a body for
1210   // any 'opaque' types in the dest module that are now resolved.
1211   TypeMap.linkDefinedTypeBodies();
1212 }
1213
1214 static void upgradeGlobalArray(GlobalVariable *GV) {
1215   ArrayType *ATy = cast<ArrayType>(GV->getType()->getElementType());
1216   StructType *OldTy = cast<StructType>(ATy->getElementType());
1217   assert(OldTy->getNumElements() == 2 && "Expected to upgrade from 2 elements");
1218
1219   // Get the upgraded 3 element type.
1220   PointerType *VoidPtrTy = Type::getInt8Ty(GV->getContext())->getPointerTo();
1221   Type *Tys[3] = {OldTy->getElementType(0), OldTy->getElementType(1),
1222                   VoidPtrTy};
1223   StructType *NewTy = StructType::get(GV->getContext(), Tys, false);
1224
1225   // Build new constants with a null third field filled in.
1226   Constant *OldInitC = GV->getInitializer();
1227   ConstantArray *OldInit = dyn_cast<ConstantArray>(OldInitC);
1228   if (!OldInit && !isa<ConstantAggregateZero>(OldInitC))
1229     // Invalid initializer; give up.
1230     return;
1231   std::vector<Constant *> Initializers;
1232   if (OldInit && OldInit->getNumOperands()) {
1233     Value *Null = Constant::getNullValue(VoidPtrTy);
1234     for (Use &U : OldInit->operands()) {
1235       ConstantStruct *Init = cast<ConstantStruct>(U.get());
1236       Initializers.push_back(ConstantStruct::get(
1237           NewTy, Init->getOperand(0), Init->getOperand(1), Null, nullptr));
1238     }
1239   }
1240   assert(Initializers.size() == ATy->getNumElements() &&
1241          "Failed to copy all array elements");
1242
1243   // Replace the old GV with a new one.
1244   ATy = ArrayType::get(NewTy, Initializers.size());
1245   Constant *NewInit = ConstantArray::get(ATy, Initializers);
1246   GlobalVariable *NewGV = new GlobalVariable(
1247       *GV->getParent(), ATy, GV->isConstant(), GV->getLinkage(), NewInit, "",
1248       GV, GV->getThreadLocalMode(), GV->getType()->getAddressSpace(),
1249       GV->isExternallyInitialized());
1250   NewGV->copyAttributesFrom(GV);
1251   NewGV->takeName(GV);
1252   assert(GV->use_empty() && "program cannot use initializer list");
1253   GV->eraseFromParent();
1254 }
1255
1256 void ModuleLinker::upgradeMismatchedGlobalArray(StringRef Name) {
1257   // Look for the global arrays.
1258   auto *DstGV = dyn_cast_or_null<GlobalVariable>(DstM->getNamedValue(Name));
1259   if (!DstGV)
1260     return;
1261   auto *SrcGV = dyn_cast_or_null<GlobalVariable>(SrcM->getNamedValue(Name));
1262   if (!SrcGV)
1263     return;
1264
1265   // Check if the types already match.
1266   auto *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
1267   auto *SrcTy =
1268       cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
1269   if (DstTy == SrcTy)
1270     return;
1271
1272   // Grab the element types.  We can only upgrade an array of a two-field
1273   // struct.  Only bother if the other one has three-fields.
1274   auto *DstEltTy = cast<StructType>(DstTy->getElementType());
1275   auto *SrcEltTy = cast<StructType>(SrcTy->getElementType());
1276   if (DstEltTy->getNumElements() == 2 && SrcEltTy->getNumElements() == 3) {
1277     upgradeGlobalArray(DstGV);
1278     return;
1279   }
1280   if (DstEltTy->getNumElements() == 3 && SrcEltTy->getNumElements() == 2)
1281     upgradeGlobalArray(SrcGV);
1282
1283   // We can't upgrade any other differences.
1284 }
1285
1286 void ModuleLinker::upgradeMismatchedGlobals() {
1287   upgradeMismatchedGlobalArray("llvm.global_ctors");
1288   upgradeMismatchedGlobalArray("llvm.global_dtors");
1289 }
1290
1291 /// If there were any appending global variables, link them together now.
1292 /// Return true on error.
1293 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
1294                                          const GlobalVariable *SrcGV) {
1295
1296   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
1297     return emitError("Linking globals named '" + SrcGV->getName() +
1298            "': can only link appending global with another appending global!");
1299
1300   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
1301   ArrayType *SrcTy =
1302     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
1303   Type *EltTy = DstTy->getElementType();
1304
1305   // Check to see that they two arrays agree on type.
1306   if (EltTy != SrcTy->getElementType())
1307     return emitError("Appending variables with different element types!");
1308   if (DstGV->isConstant() != SrcGV->isConstant())
1309     return emitError("Appending variables linked with different const'ness!");
1310
1311   if (DstGV->getAlignment() != SrcGV->getAlignment())
1312     return emitError(
1313              "Appending variables with different alignment need to be linked!");
1314
1315   if (DstGV->getVisibility() != SrcGV->getVisibility())
1316     return emitError(
1317             "Appending variables with different visibility need to be linked!");
1318
1319   if (DstGV->hasUnnamedAddr() != SrcGV->hasUnnamedAddr())
1320     return emitError(
1321         "Appending variables with different unnamed_addr need to be linked!");
1322
1323   if (StringRef(DstGV->getSection()) != SrcGV->getSection())
1324     return emitError(
1325           "Appending variables with different section name need to be linked!");
1326
1327   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
1328   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
1329
1330   // Create the new global variable.
1331   GlobalVariable *NG =
1332     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
1333                        DstGV->getLinkage(), /*init*/nullptr, /*name*/"", DstGV,
1334                        DstGV->getThreadLocalMode(),
1335                        DstGV->getType()->getAddressSpace());
1336
1337   // Propagate alignment, visibility and section info.
1338   copyGVAttributes(NG, DstGV);
1339
1340   AppendingVarInfo AVI;
1341   AVI.NewGV = NG;
1342   AVI.DstInit = DstGV->getInitializer();
1343   AVI.SrcInit = SrcGV->getInitializer();
1344   AppendingVars.push_back(AVI);
1345
1346   // Replace any uses of the two global variables with uses of the new
1347   // global.
1348   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
1349
1350   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
1351   DstGV->eraseFromParent();
1352
1353   // Track the source variable so we don't try to link it.
1354   DoNotLinkFromSource.insert(SrcGV);
1355
1356   return false;
1357 }
1358
1359 bool ModuleLinker::linkGlobalValueProto(GlobalValue *SGV) {
1360   GlobalValue *DGV = getLinkedToGlobal(SGV);
1361
1362   // Handle the ultra special appending linkage case first.
1363   assert(!DGV || SGV->hasAppendingLinkage() == DGV->hasAppendingLinkage());
1364   if (SGV->hasAppendingLinkage() && isPerformingImport()) {
1365     // Don't want to append to global_ctors list, for example, when we
1366     // are importing for ThinLTO, otherwise the global ctors and dtors
1367     // get executed multiple times for local variables (the latter causing
1368     // double frees).
1369     DoNotLinkFromSource.insert(SGV);
1370     return false;
1371   }
1372   if (DGV && DGV->hasAppendingLinkage())
1373     return linkAppendingVarProto(cast<GlobalVariable>(DGV),
1374                                  cast<GlobalVariable>(SGV));
1375
1376   bool LinkFromSrc = true;
1377   Comdat *C = nullptr;
1378   bool HasUnnamedAddr = SGV->hasUnnamedAddr();
1379
1380   if (const Comdat *SC = SGV->getComdat()) {
1381     Comdat::SelectionKind SK;
1382     std::tie(SK, LinkFromSrc) = ComdatsChosen[SC];
1383     C = DstM->getOrInsertComdat(SC->getName());
1384     C->setSelectionKind(SK);
1385   } else if (DGV) {
1386     if (shouldLinkFromSource(LinkFromSrc, *DGV, *SGV))
1387       return true;
1388   }
1389
1390   if (!LinkFromSrc) {
1391     // Track the source global so that we don't attempt to copy it over when
1392     // processing global initializers.
1393     DoNotLinkFromSource.insert(SGV);
1394
1395     if (DGV)
1396       // Make sure to remember this mapping.
1397       ValueMap[SGV] =
1398           ConstantExpr::getBitCast(DGV, TypeMap.get(SGV->getType()));
1399   }
1400
1401   if (DGV)
1402     HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr();
1403
1404   if (!LinkFromSrc && !DGV)
1405     return false;
1406
1407   GlobalValue *NewGV;
1408   if (!LinkFromSrc) {
1409     NewGV = DGV;
1410     // When linking from source we setVisibility from copyGlobalValueProto.
1411     setVisibility(NewGV, SGV, DGV);
1412   } else {
1413     // If the GV is to be lazily linked, don't create it just yet.
1414     // The ValueMaterializerTy will deal with creating it if it's used.
1415     if (!DGV && !shouldOverrideFromSrc() && SGV != ImportFunction &&
1416         (SGV->hasLocalLinkage() || SGV->hasLinkOnceLinkage() ||
1417          SGV->hasAvailableExternallyLinkage())) {
1418       DoNotLinkFromSource.insert(SGV);
1419       return false;
1420     }
1421
1422     // When we only want to link in unresolved dependencies, blacklist
1423     // the symbol unless unless DestM has a matching declaration (DGV).
1424     if (shouldLinkOnlyNeeded() && !(DGV && DGV->isDeclaration())) {
1425       DoNotLinkFromSource.insert(SGV);
1426       return false;
1427     }
1428
1429     NewGV = copyGlobalValueProto(TypeMap, SGV, DGV);
1430   }
1431
1432   NewGV->setUnnamedAddr(HasUnnamedAddr);
1433
1434   if (auto *NewGO = dyn_cast<GlobalObject>(NewGV)) {
1435     if (C)
1436       NewGO->setComdat(C);
1437
1438     if (DGV && DGV->hasCommonLinkage() && SGV->hasCommonLinkage())
1439       NewGO->setAlignment(std::max(DGV->getAlignment(), SGV->getAlignment()));
1440   }
1441
1442   if (auto *NewGVar = dyn_cast<GlobalVariable>(NewGV)) {
1443     auto *DGVar = dyn_cast_or_null<GlobalVariable>(DGV);
1444     auto *SGVar = dyn_cast<GlobalVariable>(SGV);
1445     if (DGVar && SGVar && DGVar->isDeclaration() && SGVar->isDeclaration() &&
1446         (!DGVar->isConstant() || !SGVar->isConstant()))
1447       NewGVar->setConstant(false);
1448   }
1449
1450   // Make sure to remember this mapping.
1451   if (NewGV != DGV) {
1452     if (DGV) {
1453       DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewGV, DGV->getType()));
1454       DGV->eraseFromParent();
1455     }
1456     ValueMap[SGV] = NewGV;
1457   }
1458
1459   return false;
1460 }
1461
1462 static void getArrayElements(const Constant *C,
1463                              SmallVectorImpl<Constant *> &Dest) {
1464   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
1465
1466   for (unsigned i = 0; i != NumElements; ++i)
1467     Dest.push_back(C->getAggregateElement(i));
1468 }
1469
1470 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
1471   // Merge the initializer.
1472   SmallVector<Constant *, 16> DstElements;
1473   getArrayElements(AVI.DstInit, DstElements);
1474
1475   SmallVector<Constant *, 16> SrcElements;
1476   getArrayElements(AVI.SrcInit, SrcElements);
1477
1478   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
1479
1480   StringRef Name = AVI.NewGV->getName();
1481   bool IsNewStructor =
1482       (Name == "llvm.global_ctors" || Name == "llvm.global_dtors") &&
1483       cast<StructType>(NewType->getElementType())->getNumElements() == 3;
1484
1485   for (auto *V : SrcElements) {
1486     if (IsNewStructor) {
1487       Constant *Key = V->getAggregateElement(2);
1488       if (DoNotLinkFromSource.count(Key))
1489         continue;
1490     }
1491     DstElements.push_back(
1492         MapValue(V, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1493   }
1494   if (IsNewStructor) {
1495     NewType = ArrayType::get(NewType->getElementType(), DstElements.size());
1496     AVI.NewGV->mutateType(PointerType::get(NewType, 0));
1497   }
1498
1499   AVI.NewGV->setInitializer(ConstantArray::get(NewType, DstElements));
1500 }
1501
1502 /// Update the initializers in the Dest module now that all globals that may be
1503 /// referenced are in Dest.
1504 void ModuleLinker::linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src) {
1505   // Figure out what the initializer looks like in the dest module.
1506   Dst.setInitializer(MapValue(Src.getInitializer(), ValueMap,
1507                               RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1508 }
1509
1510 /// Copy the source function over into the dest function and fix up references
1511 /// to values. At this point we know that Dest is an external function, and
1512 /// that Src is not.
1513 bool ModuleLinker::linkFunctionBody(Function &Dst, Function &Src) {
1514   assert(Dst.isDeclaration() && !Src.isDeclaration());
1515
1516   // Materialize if needed.
1517   if (std::error_code EC = Src.materialize())
1518     return emitError(EC.message());
1519
1520   // Link in the prefix data.
1521   if (Src.hasPrefixData())
1522     Dst.setPrefixData(MapValue(Src.getPrefixData(), ValueMap,
1523                                RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1524
1525   // Link in the prologue data.
1526   if (Src.hasPrologueData())
1527     Dst.setPrologueData(MapValue(Src.getPrologueData(), ValueMap,
1528                                  RF_MoveDistinctMDs, &TypeMap,
1529                                  &ValMaterializer));
1530
1531   // Link in the personality function.
1532   if (Src.hasPersonalityFn())
1533     Dst.setPersonalityFn(MapValue(Src.getPersonalityFn(), ValueMap,
1534                                   RF_MoveDistinctMDs, &TypeMap,
1535                                   &ValMaterializer));
1536
1537   // Go through and convert function arguments over, remembering the mapping.
1538   Function::arg_iterator DI = Dst.arg_begin();
1539   for (Argument &Arg : Src.args()) {
1540     DI->setName(Arg.getName());  // Copy the name over.
1541
1542     // Add a mapping to our mapping.
1543     ValueMap[&Arg] = &*DI;
1544     ++DI;
1545   }
1546
1547   // Copy over the metadata attachments.
1548   SmallVector<std::pair<unsigned, MDNode *>, 8> MDs;
1549   Src.getAllMetadata(MDs);
1550   for (const auto &I : MDs)
1551     Dst.setMetadata(I.first, MapMetadata(I.second, ValueMap, RF_MoveDistinctMDs,
1552                                          &TypeMap, &ValMaterializer));
1553
1554   // Splice the body of the source function into the dest function.
1555   Dst.getBasicBlockList().splice(Dst.end(), Src.getBasicBlockList());
1556
1557   // At this point, all of the instructions and values of the function are now
1558   // copied over.  The only problem is that they are still referencing values in
1559   // the Source function as operands.  Loop through all of the operands of the
1560   // functions and patch them up to point to the local versions.
1561   for (BasicBlock &BB : Dst)
1562     for (Instruction &I : BB)
1563       RemapInstruction(&I, ValueMap,
1564                        RF_IgnoreMissingEntries | RF_MoveDistinctMDs, &TypeMap,
1565                        &ValMaterializer);
1566
1567   // There is no need to map the arguments anymore.
1568   for (Argument &Arg : Src.args())
1569     ValueMap.erase(&Arg);
1570
1571   Src.dematerialize();
1572   return false;
1573 }
1574
1575 void ModuleLinker::linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src) {
1576   Constant *Aliasee = Src.getAliasee();
1577   Constant *Val = MapValue(Aliasee, ValueMap, RF_MoveDistinctMDs, &TypeMap,
1578                            &ValMaterializer);
1579   Dst.setAliasee(Val);
1580 }
1581
1582 bool ModuleLinker::linkGlobalValueBody(GlobalValue &Src) {
1583   Value *Dst = ValueMap[&Src];
1584   assert(Dst);
1585   if (shouldInternalizeLinkedSymbols())
1586     if (auto *DGV = dyn_cast<GlobalValue>(Dst))
1587       DGV->setLinkage(GlobalValue::InternalLinkage);
1588   if (auto *F = dyn_cast<Function>(&Src))
1589     return linkFunctionBody(cast<Function>(*Dst), *F);
1590   if (auto *GVar = dyn_cast<GlobalVariable>(&Src)) {
1591     linkGlobalInit(cast<GlobalVariable>(*Dst), *GVar);
1592     return false;
1593   }
1594   linkAliasBody(cast<GlobalAlias>(*Dst), cast<GlobalAlias>(Src));
1595   return false;
1596 }
1597
1598 /// Insert all of the named MDNodes in Src into the Dest module.
1599 void ModuleLinker::linkNamedMDNodes() {
1600   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1601   for (const NamedMDNode &NMD : SrcM->named_metadata()) {
1602     // Don't link module flags here. Do them separately.
1603     if (&NMD == SrcModFlags)
1604       continue;
1605     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(NMD.getName());
1606     // Add Src elements into Dest node.
1607     for (const MDNode *op : NMD.operands())
1608       DestNMD->addOperand(MapMetadata(op, ValueMap, RF_MoveDistinctMDs,
1609                                       &TypeMap, &ValMaterializer));
1610   }
1611 }
1612
1613 /// Merge the linker flags in Src into the Dest module.
1614 bool ModuleLinker::linkModuleFlagsMetadata() {
1615   // If the source module has no module flags, we are done.
1616   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1617   if (!SrcModFlags) return false;
1618
1619   // If the destination module doesn't have module flags yet, then just copy
1620   // over the source module's flags.
1621   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
1622   if (DstModFlags->getNumOperands() == 0) {
1623     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
1624       DstModFlags->addOperand(SrcModFlags->getOperand(I));
1625
1626     return false;
1627   }
1628
1629   // First build a map of the existing module flags and requirements.
1630   DenseMap<MDString *, std::pair<MDNode *, unsigned>> Flags;
1631   SmallSetVector<MDNode*, 16> Requirements;
1632   for (unsigned I = 0, E = DstModFlags->getNumOperands(); I != E; ++I) {
1633     MDNode *Op = DstModFlags->getOperand(I);
1634     ConstantInt *Behavior = mdconst::extract<ConstantInt>(Op->getOperand(0));
1635     MDString *ID = cast<MDString>(Op->getOperand(1));
1636
1637     if (Behavior->getZExtValue() == Module::Require) {
1638       Requirements.insert(cast<MDNode>(Op->getOperand(2)));
1639     } else {
1640       Flags[ID] = std::make_pair(Op, I);
1641     }
1642   }
1643
1644   // Merge in the flags from the source module, and also collect its set of
1645   // requirements.
1646   bool HasErr = false;
1647   for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) {
1648     MDNode *SrcOp = SrcModFlags->getOperand(I);
1649     ConstantInt *SrcBehavior =
1650         mdconst::extract<ConstantInt>(SrcOp->getOperand(0));
1651     MDString *ID = cast<MDString>(SrcOp->getOperand(1));
1652     MDNode *DstOp;
1653     unsigned DstIndex;
1654     std::tie(DstOp, DstIndex) = Flags.lookup(ID);
1655     unsigned SrcBehaviorValue = SrcBehavior->getZExtValue();
1656
1657     // If this is a requirement, add it and continue.
1658     if (SrcBehaviorValue == Module::Require) {
1659       // If the destination module does not already have this requirement, add
1660       // it.
1661       if (Requirements.insert(cast<MDNode>(SrcOp->getOperand(2)))) {
1662         DstModFlags->addOperand(SrcOp);
1663       }
1664       continue;
1665     }
1666
1667     // If there is no existing flag with this ID, just add it.
1668     if (!DstOp) {
1669       Flags[ID] = std::make_pair(SrcOp, DstModFlags->getNumOperands());
1670       DstModFlags->addOperand(SrcOp);
1671       continue;
1672     }
1673
1674     // Otherwise, perform a merge.
1675     ConstantInt *DstBehavior =
1676         mdconst::extract<ConstantInt>(DstOp->getOperand(0));
1677     unsigned DstBehaviorValue = DstBehavior->getZExtValue();
1678
1679     // If either flag has override behavior, handle it first.
1680     if (DstBehaviorValue == Module::Override) {
1681       // Diagnose inconsistent flags which both have override behavior.
1682       if (SrcBehaviorValue == Module::Override &&
1683           SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1684         HasErr |= emitError("linking module flags '" + ID->getString() +
1685                             "': IDs have conflicting override values");
1686       }
1687       continue;
1688     } else if (SrcBehaviorValue == Module::Override) {
1689       // Update the destination flag to that of the source.
1690       DstModFlags->setOperand(DstIndex, SrcOp);
1691       Flags[ID].first = SrcOp;
1692       continue;
1693     }
1694
1695     // Diagnose inconsistent merge behavior types.
1696     if (SrcBehaviorValue != DstBehaviorValue) {
1697       HasErr |= emitError("linking module flags '" + ID->getString() +
1698                           "': IDs have conflicting behaviors");
1699       continue;
1700     }
1701
1702     auto replaceDstValue = [&](MDNode *New) {
1703       Metadata *FlagOps[] = {DstOp->getOperand(0), ID, New};
1704       MDNode *Flag = MDNode::get(DstM->getContext(), FlagOps);
1705       DstModFlags->setOperand(DstIndex, Flag);
1706       Flags[ID].first = Flag;
1707     };
1708
1709     // Perform the merge for standard behavior types.
1710     switch (SrcBehaviorValue) {
1711     case Module::Require:
1712     case Module::Override: llvm_unreachable("not possible");
1713     case Module::Error: {
1714       // Emit an error if the values differ.
1715       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1716         HasErr |= emitError("linking module flags '" + ID->getString() +
1717                             "': IDs have conflicting values");
1718       }
1719       continue;
1720     }
1721     case Module::Warning: {
1722       // Emit a warning if the values differ.
1723       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1724         emitWarning("linking module flags '" + ID->getString() +
1725                     "': IDs have conflicting values");
1726       }
1727       continue;
1728     }
1729     case Module::Append: {
1730       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1731       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1732       SmallVector<Metadata *, 8> MDs;
1733       MDs.reserve(DstValue->getNumOperands() + SrcValue->getNumOperands());
1734       MDs.append(DstValue->op_begin(), DstValue->op_end());
1735       MDs.append(SrcValue->op_begin(), SrcValue->op_end());
1736
1737       replaceDstValue(MDNode::get(DstM->getContext(), MDs));
1738       break;
1739     }
1740     case Module::AppendUnique: {
1741       SmallSetVector<Metadata *, 16> Elts;
1742       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1743       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1744       Elts.insert(DstValue->op_begin(), DstValue->op_end());
1745       Elts.insert(SrcValue->op_begin(), SrcValue->op_end());
1746
1747       replaceDstValue(MDNode::get(DstM->getContext(),
1748                                   makeArrayRef(Elts.begin(), Elts.end())));
1749       break;
1750     }
1751     }
1752   }
1753
1754   // Check all of the requirements.
1755   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1756     MDNode *Requirement = Requirements[I];
1757     MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1758     Metadata *ReqValue = Requirement->getOperand(1);
1759
1760     MDNode *Op = Flags[Flag].first;
1761     if (!Op || Op->getOperand(2) != ReqValue) {
1762       HasErr |= emitError("linking module flags '" + Flag->getString() +
1763                           "': does not have the required value");
1764       continue;
1765     }
1766   }
1767
1768   return HasErr;
1769 }
1770
1771 // This function returns true if the triples match.
1772 static bool triplesMatch(const Triple &T0, const Triple &T1) {
1773   // If vendor is apple, ignore the version number.
1774   if (T0.getVendor() == Triple::Apple)
1775     return T0.getArch() == T1.getArch() &&
1776            T0.getSubArch() == T1.getSubArch() &&
1777            T0.getVendor() == T1.getVendor() &&
1778            T0.getOS() == T1.getOS();
1779
1780   return T0 == T1;
1781 }
1782
1783 // This function returns the merged triple.
1784 static std::string mergeTriples(const Triple &SrcTriple, const Triple &DstTriple) {
1785   // If vendor is apple, pick the triple with the larger version number.
1786   if (SrcTriple.getVendor() == Triple::Apple)
1787     if (DstTriple.isOSVersionLT(SrcTriple))
1788       return SrcTriple.str();
1789
1790   return DstTriple.str();
1791 }
1792
1793 bool ModuleLinker::run() {
1794   assert(DstM && "Null destination module");
1795   assert(SrcM && "Null source module");
1796
1797   // Inherit the target data from the source module if the destination module
1798   // doesn't have one already.
1799   if (DstM->getDataLayout().isDefault())
1800     DstM->setDataLayout(SrcM->getDataLayout());
1801
1802   if (SrcM->getDataLayout() != DstM->getDataLayout()) {
1803     emitWarning("Linking two modules of different data layouts: '" +
1804                 SrcM->getModuleIdentifier() + "' is '" +
1805                 SrcM->getDataLayoutStr() + "' whereas '" +
1806                 DstM->getModuleIdentifier() + "' is '" +
1807                 DstM->getDataLayoutStr() + "'\n");
1808   }
1809
1810   // Copy the target triple from the source to dest if the dest's is empty.
1811   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1812     DstM->setTargetTriple(SrcM->getTargetTriple());
1813
1814   Triple SrcTriple(SrcM->getTargetTriple()), DstTriple(DstM->getTargetTriple());
1815
1816   if (!SrcM->getTargetTriple().empty() && !triplesMatch(SrcTriple, DstTriple))
1817     emitWarning("Linking two modules of different target triples: " +
1818                 SrcM->getModuleIdentifier() + "' is '" +
1819                 SrcM->getTargetTriple() + "' whereas '" +
1820                 DstM->getModuleIdentifier() + "' is '" +
1821                 DstM->getTargetTriple() + "'\n");
1822
1823   DstM->setTargetTriple(mergeTriples(SrcTriple, DstTriple));
1824
1825   // Append the module inline asm string.
1826   if (!SrcM->getModuleInlineAsm().empty()) {
1827     if (DstM->getModuleInlineAsm().empty())
1828       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1829     else
1830       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1831                                SrcM->getModuleInlineAsm());
1832   }
1833
1834   // Loop over all of the linked values to compute type mappings.
1835   computeTypeMapping();
1836
1837   ComdatsChosen.clear();
1838   for (const auto &SMEC : SrcM->getComdatSymbolTable()) {
1839     const Comdat &C = SMEC.getValue();
1840     if (ComdatsChosen.count(&C))
1841       continue;
1842     Comdat::SelectionKind SK;
1843     bool LinkFromSrc;
1844     if (getComdatResult(&C, SK, LinkFromSrc))
1845       return true;
1846     ComdatsChosen[&C] = std::make_pair(SK, LinkFromSrc);
1847   }
1848
1849   // Upgrade mismatched global arrays.
1850   upgradeMismatchedGlobals();
1851
1852   // Insert all of the globals in src into the DstM module... without linking
1853   // initializers (which could refer to functions not yet mapped over).
1854   for (GlobalVariable &GV : SrcM->globals())
1855     if (linkGlobalValueProto(&GV))
1856       return true;
1857
1858   // Link the functions together between the two modules, without doing function
1859   // bodies... this just adds external function prototypes to the DstM
1860   // function...  We do this so that when we begin processing function bodies,
1861   // all of the global values that may be referenced are available in our
1862   // ValueMap.
1863   for (Function &F :*SrcM)
1864     if (linkGlobalValueProto(&F))
1865       return true;
1866
1867   // If there were any aliases, link them now.
1868   for (GlobalAlias &GA : SrcM->aliases())
1869     if (linkGlobalValueProto(&GA))
1870       return true;
1871
1872   for (const AppendingVarInfo &AppendingVar : AppendingVars)
1873     linkAppendingVarInit(AppendingVar);
1874
1875   for (const auto &Entry : DstM->getComdatSymbolTable()) {
1876     const Comdat &C = Entry.getValue();
1877     if (C.getSelectionKind() == Comdat::Any)
1878       continue;
1879     const GlobalValue *GV = SrcM->getNamedValue(C.getName());
1880     if (GV)
1881       MapValue(GV, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer);
1882   }
1883
1884   // Link in the function bodies that are defined in the source module into
1885   // DstM.
1886   for (Function &SF : *SrcM) {
1887     // Skip if no body (function is external).
1888     if (SF.isDeclaration())
1889       continue;
1890
1891     // Skip if not linking from source.
1892     if (DoNotLinkFromSource.count(&SF))
1893       continue;
1894
1895     // When importing, only materialize the function requested for import.
1896     if (isPerformingImport() && &SF != ImportFunction)
1897       continue;
1898
1899     if (linkGlobalValueBody(SF))
1900       return true;
1901   }
1902
1903   // Resolve all uses of aliases with aliasees.
1904   for (GlobalAlias &Src : SrcM->aliases()) {
1905     if (DoNotLinkFromSource.count(&Src))
1906       continue;
1907     linkGlobalValueBody(Src);
1908   }
1909
1910   // Update the initializers in the DstM module now that all globals that may
1911   // be referenced are in DstM.
1912   for (GlobalVariable &Src : SrcM->globals()) {
1913     // Only process initialized GV's or ones not already in dest.
1914     if (!Src.hasInitializer() || DoNotLinkFromSource.count(&Src))
1915       continue;
1916     linkGlobalValueBody(Src);
1917   }
1918
1919   // Process vector of lazily linked in functions.
1920   while (!LazilyLinkGlobalValues.empty()) {
1921     GlobalValue *SGV = LazilyLinkGlobalValues.back();
1922     LazilyLinkGlobalValues.pop_back();
1923     if (isPerformingImport() && !doImportAsDefinition(SGV))
1924       continue;
1925
1926     // Skip declarations that ValueMaterializer may have created in
1927     // case we link in only some of SrcM.
1928     if (shouldLinkOnlyNeeded() && SGV->isDeclaration())
1929       continue;
1930
1931     assert(!SGV->isDeclaration() && "users should not pass down decls");
1932     if (linkGlobalValueBody(*SGV))
1933       return true;
1934   }
1935
1936   // Note that we are done linking global value bodies. This prevents
1937   // metadata linking from creating new references.
1938   DoneLinkingBodies = true;
1939
1940   // Remap all of the named MDNodes in Src into the DstM module. We do this
1941   // after linking GlobalValues so that MDNodes that reference GlobalValues
1942   // are properly remapped.
1943   linkNamedMDNodes();
1944
1945   // Merge the module flags into the DstM module.
1946   if (linkModuleFlagsMetadata())
1947     return true;
1948
1949   return false;
1950 }
1951
1952 Linker::StructTypeKeyInfo::KeyTy::KeyTy(ArrayRef<Type *> E, bool P)
1953     : ETypes(E), IsPacked(P) {}
1954
1955 Linker::StructTypeKeyInfo::KeyTy::KeyTy(const StructType *ST)
1956     : ETypes(ST->elements()), IsPacked(ST->isPacked()) {}
1957
1958 bool Linker::StructTypeKeyInfo::KeyTy::operator==(const KeyTy &That) const {
1959   if (IsPacked != That.IsPacked)
1960     return false;
1961   if (ETypes != That.ETypes)
1962     return false;
1963   return true;
1964 }
1965
1966 bool Linker::StructTypeKeyInfo::KeyTy::operator!=(const KeyTy &That) const {
1967   return !this->operator==(That);
1968 }
1969
1970 StructType *Linker::StructTypeKeyInfo::getEmptyKey() {
1971   return DenseMapInfo<StructType *>::getEmptyKey();
1972 }
1973
1974 StructType *Linker::StructTypeKeyInfo::getTombstoneKey() {
1975   return DenseMapInfo<StructType *>::getTombstoneKey();
1976 }
1977
1978 unsigned Linker::StructTypeKeyInfo::getHashValue(const KeyTy &Key) {
1979   return hash_combine(hash_combine_range(Key.ETypes.begin(), Key.ETypes.end()),
1980                       Key.IsPacked);
1981 }
1982
1983 unsigned Linker::StructTypeKeyInfo::getHashValue(const StructType *ST) {
1984   return getHashValue(KeyTy(ST));
1985 }
1986
1987 bool Linker::StructTypeKeyInfo::isEqual(const KeyTy &LHS,
1988                                         const StructType *RHS) {
1989   if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1990     return false;
1991   return LHS == KeyTy(RHS);
1992 }
1993
1994 bool Linker::StructTypeKeyInfo::isEqual(const StructType *LHS,
1995                                         const StructType *RHS) {
1996   if (RHS == getEmptyKey())
1997     return LHS == getEmptyKey();
1998
1999   if (RHS == getTombstoneKey())
2000     return LHS == getTombstoneKey();
2001
2002   return KeyTy(LHS) == KeyTy(RHS);
2003 }
2004
2005 void Linker::IdentifiedStructTypeSet::addNonOpaque(StructType *Ty) {
2006   assert(!Ty->isOpaque());
2007   NonOpaqueStructTypes.insert(Ty);
2008 }
2009
2010 void Linker::IdentifiedStructTypeSet::switchToNonOpaque(StructType *Ty) {
2011   assert(!Ty->isOpaque());
2012   NonOpaqueStructTypes.insert(Ty);
2013   bool Removed = OpaqueStructTypes.erase(Ty);
2014   (void)Removed;
2015   assert(Removed);
2016 }
2017
2018 void Linker::IdentifiedStructTypeSet::addOpaque(StructType *Ty) {
2019   assert(Ty->isOpaque());
2020   OpaqueStructTypes.insert(Ty);
2021 }
2022
2023 StructType *
2024 Linker::IdentifiedStructTypeSet::findNonOpaque(ArrayRef<Type *> ETypes,
2025                                                bool IsPacked) {
2026   Linker::StructTypeKeyInfo::KeyTy Key(ETypes, IsPacked);
2027   auto I = NonOpaqueStructTypes.find_as(Key);
2028   if (I == NonOpaqueStructTypes.end())
2029     return nullptr;
2030   return *I;
2031 }
2032
2033 bool Linker::IdentifiedStructTypeSet::hasType(StructType *Ty) {
2034   if (Ty->isOpaque())
2035     return OpaqueStructTypes.count(Ty);
2036   auto I = NonOpaqueStructTypes.find(Ty);
2037   if (I == NonOpaqueStructTypes.end())
2038     return false;
2039   return *I == Ty;
2040 }
2041
2042 void Linker::init(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
2043   this->Composite = M;
2044   this->DiagnosticHandler = DiagnosticHandler;
2045
2046   TypeFinder StructTypes;
2047   StructTypes.run(*M, true);
2048   for (StructType *Ty : StructTypes) {
2049     if (Ty->isOpaque())
2050       IdentifiedStructTypes.addOpaque(Ty);
2051     else
2052       IdentifiedStructTypes.addNonOpaque(Ty);
2053   }
2054 }
2055
2056 Linker::Linker(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
2057   init(M, DiagnosticHandler);
2058 }
2059
2060 Linker::Linker(Module *M) {
2061   init(M, [this](const DiagnosticInfo &DI) {
2062     Composite->getContext().diagnose(DI);
2063   });
2064 }
2065
2066 void Linker::deleteModule() {
2067   delete Composite;
2068   Composite = nullptr;
2069 }
2070
2071 bool Linker::linkInModule(Module *Src, unsigned Flags, FunctionInfoIndex *Index,
2072                           Function *FuncToImport) {
2073   ModuleLinker TheLinker(Composite, IdentifiedStructTypes, Src,
2074                          DiagnosticHandler, Flags, Index, FuncToImport);
2075   bool RetCode = TheLinker.run();
2076   Composite->dropTriviallyDeadConstantArrays();
2077   return RetCode;
2078 }
2079
2080 void Linker::setModule(Module *Dst) {
2081   init(Dst, DiagnosticHandler);
2082 }
2083
2084 //===----------------------------------------------------------------------===//
2085 // LinkModules entrypoint.
2086 //===----------------------------------------------------------------------===//
2087
2088 /// This function links two modules together, with the resulting Dest module
2089 /// modified to be the composite of the two input modules. If an error occurs,
2090 /// true is returned and ErrorMsg (if not null) is set to indicate the problem.
2091 /// Upon failure, the Dest module could be in a modified state, and shouldn't be
2092 /// relied on to be consistent.
2093 bool Linker::LinkModules(Module *Dest, Module *Src,
2094                          DiagnosticHandlerFunction DiagnosticHandler,
2095                          unsigned Flags) {
2096   Linker L(Dest, DiagnosticHandler);
2097   return L.linkInModule(Src, Flags);
2098 }
2099
2100 bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Flags) {
2101   Linker L(Dest);
2102   return L.linkInModule(Src, Flags);
2103 }
2104
2105 //===----------------------------------------------------------------------===//
2106 // C API.
2107 //===----------------------------------------------------------------------===//
2108
2109 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
2110                          LLVMLinkerMode Unused, char **OutMessages) {
2111   Module *D = unwrap(Dest);
2112   std::string Message;
2113   raw_string_ostream Stream(Message);
2114   DiagnosticPrinterRawOStream DP(Stream);
2115
2116   LLVMBool Result = Linker::LinkModules(
2117       D, unwrap(Src), [&](const DiagnosticInfo &DI) { DI.print(DP); });
2118
2119   if (OutMessages && Result) {
2120     Stream.flush();
2121     *OutMessages = strdup(Message.c_str());
2122   }
2123   return Result;
2124 }