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() && !doImportAsDefinition(GA));
 630     NewGV->copyAttributesFrom(GA->getBaseObject());
 631   } else
 632     NewGV->copyAttributesFrom(SrcGV);
 633   forceRenaming(NewGV, getName(SrcGV));
 634 }
 635
 636 static bool isLessConstraining(GlobalValue::VisibilityTypes a,
 637                                GlobalValue::VisibilityTypes b) {
 638   if (a == GlobalValue::HiddenVisibility)
 639     return false;
 640   if (b == GlobalValue::HiddenVisibility)
 641     return true;
 642   if (a == GlobalValue::ProtectedVisibility)
 643     return false;
 644   if (b == GlobalValue::ProtectedVisibility)
 645     return true;
 646   return false;
 647 }
 648
 649 bool ModuleLinker::doImportAsDefinition(const GlobalValue *SGV) {
 650   if (!isPerformingImport())
 651     return false;
 652   auto *GA = dyn_cast<GlobalAlias>(SGV);
 653   if (GA) {
 654     if (GA->hasWeakAnyLinkage())
 655       return false;
 656     return doImportAsDefinition(GA->getBaseObject());
 657   }
 658   // Always import GlobalVariable definitions. The linkage changes
 659   // described in ModuleLinker::getLinkage ensure the correct behavior (e.g.
 660   // global variables with external linkage are transformed to
 661   // available_externally definitions, which are ultimately turned into
 662   // declarations after the EliminateAvailableExternally pass).
 663   if (dyn_cast<GlobalVariable>(SGV) && !SGV->isDeclaration() &&
 664       !SGV->hasWeakAnyLinkage())
 665     return true;
 666   // Only import the function requested for importing.
 667   auto *SF = dyn_cast<Function>(SGV);
 668   if (SF && SF == ImportFunction)
 669     return true;
 670   // Otherwise no.
 671   return false;
 672 }
 673
 674 bool ModuleLinker::doPromoteLocalToGlobal(const GlobalValue *SGV) {
 675   assert(SGV->hasLocalLinkage());
 676   // Both the imported references and the original local variable must
 677   // be promoted.
 678   if (!isPerformingImport() && !isModuleExporting())
 679     return false;
 680
 681   // Local const variables never need to be promoted unless they are address
 682   // taken. The imported uses can simply use the clone created in this module.
 683   // For now we are conservative in determining which variables are not
 684   // address taken by checking the unnamed addr flag. To be more aggressive,
 685   // the address taken information must be checked earlier during parsing
 686   // of the module and recorded in the function index for use when importing
 687   // from that module.
 688   auto *GVar = dyn_cast<GlobalVariable>(SGV);
 689   if (GVar && GVar->isConstant() && GVar->hasUnnamedAddr())
 690     return false;
 691
 692   // Eventually we only need to promote functions in the exporting module that
 693   // are referenced by a potentially exported function (i.e. one that is in the
 694   // function index).
 695   return true;
 696 }
 697
 698 std::string ModuleLinker::getName(const GlobalValue *SGV) {
 699   // For locals that must be promoted to global scope, ensure that
 700   // the promoted name uniquely identifies the copy in the original module,
 701   // using the ID assigned during combined index creation. When importing,
 702   // we rename all locals (not just those that are promoted) in order to
 703   // avoid naming conflicts between locals imported from different modules.
 704   if (SGV->hasLocalLinkage() &&
 705       (doPromoteLocalToGlobal(SGV) || isPerformingImport()))
 706     return FunctionInfoIndex::getGlobalNameForLocal(
 707         SGV->getName(),
 708         ImportIndex->getModuleId(SGV->getParent()->getModuleIdentifier()));
 709   return SGV->getName();
 710 }
 711
 712 GlobalValue::LinkageTypes ModuleLinker::getLinkage(const GlobalValue *SGV) {
 713   // Any local variable that is referenced by an exported function needs
 714   // to be promoted to global scope. Since we don't currently know which
 715   // functions reference which local variables/functions, we must treat
 716   // all as potentially exported if this module is exporting anything.
 717   if (isModuleExporting()) {
 718     if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
 719       return GlobalValue::ExternalLinkage;
 720     return SGV->getLinkage();
 721   }
 722
 723   // Otherwise, if we aren't importing, no linkage change is needed.
 724   if (!isPerformingImport())
 725     return SGV->getLinkage();
 726
 727   switch (SGV->getLinkage()) {
 728   case GlobalValue::ExternalLinkage:
 729     // External defnitions are converted to available_externally
 730     // definitions upon import, so that they are available for inlining
 731     // and/or optimization, but are turned into declarations later
 732     // during the EliminateAvailableExternally pass.
 733     if (doImportAsDefinition(SGV) && !dyn_cast<GlobalAlias>(SGV))
 734       return GlobalValue::AvailableExternallyLinkage;
 735     // An imported external declaration stays external.
 736     return SGV->getLinkage();
 737
 738   case GlobalValue::AvailableExternallyLinkage:
 739     // An imported available_externally definition converts
 740     // to external if imported as a declaration.
 741     if (!doImportAsDefinition(SGV))
 742       return GlobalValue::ExternalLinkage;
 743     // An imported available_externally declaration stays that way.
 744     return SGV->getLinkage();
 745
 746   case GlobalValue::LinkOnceAnyLinkage:
 747   case GlobalValue::LinkOnceODRLinkage:
 748     // These both stay the same when importing the definition.
 749     // The ThinLTO pass will eventually force-import their definitions.
 750     return SGV->getLinkage();
 751
 752   case GlobalValue::WeakAnyLinkage:
 753     // Can't import weak_any definitions correctly, or we might change the
 754     // program semantics, since the linker will pick the first weak_any
 755     // definition and importing would change the order they are seen by the
 756     // linker. The module linking caller needs to enforce this.
 757     assert(!doImportAsDefinition(SGV));
 758     // If imported as a declaration, it becomes external_weak.
 759     return GlobalValue::ExternalWeakLinkage;
 760
 761   case GlobalValue::WeakODRLinkage:
 762     // For weak_odr linkage, there is a guarantee that all copies will be
 763     // equivalent, so the issue described above for weak_any does not exist,
 764     // and the definition can be imported. It can be treated similarly
 765     // to an imported externally visible global value.
 766     if (doImportAsDefinition(SGV) && !dyn_cast<GlobalAlias>(SGV))
 767       return GlobalValue::AvailableExternallyLinkage;
 768     else
 769       return GlobalValue::ExternalLinkage;
 770
 771   case GlobalValue::AppendingLinkage:
 772     // It would be incorrect to import an appending linkage variable,
 773     // since it would cause global constructors/destructors to be
 774     // executed multiple times. This should have already been handled
 775     // by linkGlobalValueProto.
 776     assert(false && "Cannot import appending linkage variable");
 777
 778   case GlobalValue::InternalLinkage:
 779   case GlobalValue::PrivateLinkage:
 780     // If we are promoting the local to global scope, it is handled
 781     // similarly to a normal externally visible global.
 782     if (doPromoteLocalToGlobal(SGV)) {
 783       if (doImportAsDefinition(SGV) && !dyn_cast<GlobalAlias>(SGV))
 784         return GlobalValue::AvailableExternallyLinkage;
 785       else
 786         return GlobalValue::ExternalLinkage;
 787     }
 788     // A non-promoted imported local definition stays local.
 789     // The ThinLTO pass will eventually force-import their definitions.
 790     return SGV->getLinkage();
 791
 792   case GlobalValue::ExternalWeakLinkage:
 793     // External weak doesn't apply to definitions, must be a declaration.
 794     assert(!doImportAsDefinition(SGV));
 795     // Linkage stays external_weak.
 796     return SGV->getLinkage();
 797
 798   case GlobalValue::CommonLinkage:
 799     // Linkage stays common on definitions.
 800     // The ThinLTO pass will eventually force-import their definitions.
 801     return SGV->getLinkage();
 802   }
 803
 804   llvm_unreachable("unknown linkage type");
 805 }
 806
 807 /// Loop through the global variables in the src module and merge them into the
 808 /// dest module.
 809 GlobalVariable *
 810 ModuleLinker::copyGlobalVariableProto(TypeMapTy &TypeMap,
 811                                       const GlobalVariable *SGVar) {
 812   // No linking to be performed or linking from the source: simply create an
 813   // identical version of the symbol over in the dest module... the
 814   // initializer will be filled in later by LinkGlobalInits.
 815   GlobalVariable *NewDGV = new GlobalVariable(
 816       *DstM, TypeMap.get(SGVar->getType()->getElementType()),
 817       SGVar->isConstant(), getLinkage(SGVar), /*init*/ nullptr, getName(SGVar),
 818       /*insertbefore*/ nullptr, SGVar->getThreadLocalMode(),
 819       SGVar->getType()->getAddressSpace());
 820
 821   return NewDGV;
 822 }
 823
 824 /// Link the function in the source module into the destination module if
 825 /// needed, setting up mapping information.
 826 Function *ModuleLinker::copyFunctionProto(TypeMapTy &TypeMap,
 827                                           const Function *SF) {
 828   // If there is no linkage to be performed or we are linking from the source,
 829   // bring SF over.
 830   return Function::Create(TypeMap.get(SF->getFunctionType()), getLinkage(SF),
 831                           getName(SF), DstM);
 832 }
 833
 834 /// Set up prototypes for any aliases that come over from the source module.
 835 GlobalValue *ModuleLinker::copyGlobalAliasProto(TypeMapTy &TypeMap,
 836                                                 const GlobalAlias *SGA) {
 837   // If we are importing and encounter a weak_any alias, or an alias to
 838   // an object being imported as a declaration, we must import the alias
 839   // as a declaration as well, which involves converting it to a non-alias.
 840   // See comments in ModuleLinker::getLinkage for why we cannot import
 841   // weak_any defintions.
 842   if (isPerformingImport() && !doImportAsDefinition(SGA)) {
 843     // Need to convert to declaration. All aliases must be definitions.
 844     const GlobalValue *GVal = SGA->getBaseObject();
 845     GlobalValue *NewGV;
 846     if (auto *GVar = dyn_cast<GlobalVariable>(GVal))
 847       NewGV = copyGlobalVariableProto(TypeMap, GVar);
 848     else {
 849       auto *F = dyn_cast<Function>(GVal);
 850       assert(F);
 851       NewGV = copyFunctionProto(TypeMap, F);
 852     }
 853     // Set the linkage to External or ExternalWeak (see comments in
 854     // ModuleLinker::getLinkage for why WeakAny is converted to ExternalWeak).
 855     if (SGA->hasWeakAnyLinkage())
 856       NewGV->setLinkage(GlobalValue::ExternalWeakLinkage);
 857     else
 858       NewGV->setLinkage(GlobalValue::ExternalLinkage);
 859     return NewGV;
 860   }
 861   // If there is no linkage to be performed or we're linking from the source,
 862   // bring over SGA.
 863   auto *Ty = TypeMap.get(SGA->getValueType());
 864   return GlobalAlias::create(Ty, SGA->getType()->getPointerAddressSpace(),
 865                              getLinkage(SGA), getName(SGA), DstM);
 866 }
 867
 868 void ModuleLinker::setVisibility(GlobalValue *NewGV, const GlobalValue *SGV,
 869                                  const GlobalValue *DGV) {
 870   GlobalValue::VisibilityTypes Visibility = SGV->getVisibility();
 871   if (DGV)
 872     Visibility = isLessConstraining(Visibility, DGV->getVisibility())
 873                      ? DGV->getVisibility()
 874                      : Visibility;
 875   // For promoted locals, mark them hidden so that they can later be
 876   // stripped from the symbol table to reduce bloat.
 877   if (SGV->hasLocalLinkage() && doPromoteLocalToGlobal(SGV))
 878     Visibility = GlobalValue::HiddenVisibility;
 879   NewGV->setVisibility(Visibility);
 880 }
 881
 882 GlobalValue *ModuleLinker::copyGlobalValueProto(TypeMapTy &TypeMap,
 883                                                 const GlobalValue *SGV,
 884                                                 const GlobalValue *DGV) {
 885   GlobalValue *NewGV;
 886   if (auto *SGVar = dyn_cast<GlobalVariable>(SGV))
 887     NewGV = copyGlobalVariableProto(TypeMap, SGVar);
 888   else if (auto *SF = dyn_cast<Function>(SGV))
 889     NewGV = copyFunctionProto(TypeMap, SF);
 890   else
 891     NewGV = copyGlobalAliasProto(TypeMap, cast<GlobalAlias>(SGV));
 892   copyGVAttributes(NewGV, SGV);
 893   setVisibility(NewGV, SGV, DGV);
 894   return NewGV;
 895 }
 896
 897 Value *ValueMaterializerTy::materializeValueFor(Value *V) {
 898   auto *SGV = dyn_cast<GlobalValue>(V);
 899   if (!SGV)
 900     return nullptr;
 901
 902   // If we are done linking global value bodies (i.e. we are performing
 903   // metadata linking), don't link in the global value due to this
 904   // reference, simply map it to null.
 905   if (ModLinker->doneLinkingBodies())
 906     return nullptr;
 907
 908   GlobalValue *DGV = ModLinker->copyGlobalValueProto(TypeMap, SGV);
 909
 910   if (Comdat *SC = SGV->getComdat()) {
 911     if (auto *DGO = dyn_cast<GlobalObject>(DGV)) {
 912       Comdat *DC = DstM->getOrInsertComdat(SC->getName());
 913       DGO->setComdat(DC);
 914     }
 915   }
 916
 917   LazilyLinkGlobalValues.push_back(SGV);
 918   return DGV;
 919 }
 920
 921 bool ModuleLinker::getComdatLeader(Module *M, StringRef ComdatName,
 922                                    const GlobalVariable *&GVar) {
 923   const GlobalValue *GVal = M->getNamedValue(ComdatName);
 924   if (const auto *GA = dyn_cast_or_null<GlobalAlias>(GVal)) {
 925     GVal = GA->getBaseObject();
 926     if (!GVal)
 927       // We cannot resolve the size of the aliasee yet.
 928       return emitError("Linking COMDATs named '" + ComdatName +
 929                        "': COMDAT key involves incomputable alias size.");
 930   }
 931
 932   GVar = dyn_cast_or_null<GlobalVariable>(GVal);
 933   if (!GVar)
 934     return emitError(
 935         "Linking COMDATs named '" + ComdatName +
 936         "': GlobalVariable required for data dependent selection!");
 937
 938   return false;
 939 }
 940
 941 bool ModuleLinker::computeResultingSelectionKind(StringRef ComdatName,
 942                                                  Comdat::SelectionKind Src,
 943                                                  Comdat::SelectionKind Dst,
 944                                                  Comdat::SelectionKind &Result,
 945                                                  bool &LinkFromSrc) {
 946   // The ability to mix Comdat::SelectionKind::Any with
 947   // Comdat::SelectionKind::Largest is a behavior that comes from COFF.
 948   bool DstAnyOrLargest = Dst == Comdat::SelectionKind::Any ||
 949                          Dst == Comdat::SelectionKind::Largest;
 950   bool SrcAnyOrLargest = Src == Comdat::SelectionKind::Any ||
 951                          Src == Comdat::SelectionKind::Largest;
 952   if (DstAnyOrLargest && SrcAnyOrLargest) {
 953     if (Dst == Comdat::SelectionKind::Largest ||
 954         Src == Comdat::SelectionKind::Largest)
 955       Result = Comdat::SelectionKind::Largest;
 956     else
 957       Result = Comdat::SelectionKind::Any;
 958   } else if (Src == Dst) {
 959     Result = Dst;
 960   } else {
 961     return emitError("Linking COMDATs named '" + ComdatName +
 962                      "': invalid selection kinds!");
 963   }
 964
 965   switch (Result) {
 966   case Comdat::SelectionKind::Any:
 967     // Go with Dst.
 968     LinkFromSrc = false;
 969     break;
 970   case Comdat::SelectionKind::NoDuplicates:
 971     return emitError("Linking COMDATs named '" + ComdatName +
 972                      "': noduplicates has been violated!");
 973   case Comdat::SelectionKind::ExactMatch:
 974   case Comdat::SelectionKind::Largest:
 975   case Comdat::SelectionKind::SameSize: {
 976     const GlobalVariable *DstGV;
 977     const GlobalVariable *SrcGV;
 978     if (getComdatLeader(DstM, ComdatName, DstGV) ||
 979         getComdatLeader(SrcM, ComdatName, SrcGV))
 980       return true;
 981
 982     const DataLayout &DstDL = DstM->getDataLayout();
 983     const DataLayout &SrcDL = SrcM->getDataLayout();
 984     uint64_t DstSize =
 985         DstDL.getTypeAllocSize(DstGV->getType()->getPointerElementType());
 986     uint64_t SrcSize =
 987         SrcDL.getTypeAllocSize(SrcGV->getType()->getPointerElementType());
 988     if (Result == Comdat::SelectionKind::ExactMatch) {
 989       if (SrcGV->getInitializer() != DstGV->getInitializer())
 990         return emitError("Linking COMDATs named '" + ComdatName +
 991                          "': ExactMatch violated!");
 992       LinkFromSrc = false;
 993     } else if (Result == Comdat::SelectionKind::Largest) {
 994       LinkFromSrc = SrcSize > DstSize;
 995     } else if (Result == Comdat::SelectionKind::SameSize) {
 996       if (SrcSize != DstSize)
 997         return emitError("Linking COMDATs named '" + ComdatName +
 998                          "': SameSize violated!");
 999       LinkFromSrc = false;
1000     } else {
1001       llvm_unreachable("unknown selection kind");
1002     }
1003     break;
1004   }
1005   }
1006
1007   return false;
1008 }
1009
1010 bool ModuleLinker::getComdatResult(const Comdat *SrcC,
1011                                    Comdat::SelectionKind &Result,
1012                                    bool &LinkFromSrc) {
1013   Comdat::SelectionKind SSK = SrcC->getSelectionKind();
1014   StringRef ComdatName = SrcC->getName();
1015   Module::ComdatSymTabType &ComdatSymTab = DstM->getComdatSymbolTable();
1016   Module::ComdatSymTabType::iterator DstCI = ComdatSymTab.find(ComdatName);
1017
1018   if (DstCI == ComdatSymTab.end()) {
1019     // Use the comdat if it is only available in one of the modules.
1020     LinkFromSrc = true;
1021     Result = SSK;
1022     return false;
1023   }
1024
1025   const Comdat *DstC = &DstCI->second;
1026   Comdat::SelectionKind DSK = DstC->getSelectionKind();
1027   return computeResultingSelectionKind(ComdatName, SSK, DSK, Result,
1028                                        LinkFromSrc);
1029 }
1030
1031 bool ModuleLinker::shouldLinkFromSource(bool &LinkFromSrc,
1032                                         const GlobalValue &Dest,
1033                                         const GlobalValue &Src) {
1034   // Should we unconditionally use the Src?
1035   if (shouldOverrideFromSrc()) {
1036     LinkFromSrc = true;
1037     return false;
1038   }
1039
1040   // We always have to add Src if it has appending linkage.
1041   if (Src.hasAppendingLinkage()) {
1042     // Caller should have already determined that we can't link from source
1043     // when importing (see comments in linkGlobalValueProto).
1044     assert(!isPerformingImport());
1045     LinkFromSrc = true;
1046     return false;
1047   }
1048
1049   bool SrcIsDeclaration = Src.isDeclarationForLinker();
1050   bool DestIsDeclaration = Dest.isDeclarationForLinker();
1051
1052   if (isPerformingImport()) {
1053     if (isa<Function>(&Src)) {
1054       // For functions, LinkFromSrc iff this is the function requested
1055       // for importing. For variables, decide below normally.
1056       LinkFromSrc = (&Src == ImportFunction);
1057       return false;
1058     }
1059
1060     // Check if this is an alias with an already existing definition
1061     // in Dest, which must have come from a prior importing pass from
1062     // the same Src module. Unlike imported function and variable
1063     // definitions, which are imported as available_externally and are
1064     // not definitions for the linker, that is not a valid linkage for
1065     // imported aliases which must be definitions. Simply use the existing
1066     // Dest copy.
1067     if (isa<GlobalAlias>(&Src) && !DestIsDeclaration) {
1068       assert(isa<GlobalAlias>(&Dest));
1069       LinkFromSrc = false;
1070       return false;
1071     }
1072   }
1073
1074   if (SrcIsDeclaration) {
1075     // If Src is external or if both Src & Dest are external..  Just link the
1076     // external globals, we aren't adding anything.
1077     if (Src.hasDLLImportStorageClass()) {
1078       // If one of GVs is marked as DLLImport, result should be dllimport'ed.
1079       LinkFromSrc = DestIsDeclaration;
1080       return false;
1081     }
1082     // If the Dest is weak, use the source linkage.
1083     LinkFromSrc = Dest.hasExternalWeakLinkage();
1084     return false;
1085   }
1086
1087   if (DestIsDeclaration) {
1088     // If Dest is external but Src is not:
1089     LinkFromSrc = true;
1090     return false;
1091   }
1092
1093   if (Src.hasCommonLinkage()) {
1094     if (Dest.hasLinkOnceLinkage() || Dest.hasWeakLinkage()) {
1095       LinkFromSrc = true;
1096       return false;
1097     }
1098
1099     if (!Dest.hasCommonLinkage()) {
1100       LinkFromSrc = false;
1101       return false;
1102     }
1103
1104     const DataLayout &DL = Dest.getParent()->getDataLayout();
1105     uint64_t DestSize = DL.getTypeAllocSize(Dest.getType()->getElementType());
1106     uint64_t SrcSize = DL.getTypeAllocSize(Src.getType()->getElementType());
1107     LinkFromSrc = SrcSize > DestSize;
1108     return false;
1109   }
1110
1111   if (Src.isWeakForLinker()) {
1112     assert(!Dest.hasExternalWeakLinkage());
1113     assert(!Dest.hasAvailableExternallyLinkage());
1114
1115     if (Dest.hasLinkOnceLinkage() && Src.hasWeakLinkage()) {
1116       LinkFromSrc = true;
1117       return false;
1118     }
1119
1120     LinkFromSrc = false;
1121     return false;
1122   }
1123
1124   if (Dest.isWeakForLinker()) {
1125     assert(Src.hasExternalLinkage());
1126     LinkFromSrc = true;
1127     return false;
1128   }
1129
1130   assert(!Src.hasExternalWeakLinkage());
1131   assert(!Dest.hasExternalWeakLinkage());
1132   assert(Dest.hasExternalLinkage() && Src.hasExternalLinkage() &&
1133          "Unexpected linkage type!");
1134   return emitError("Linking globals named '" + Src.getName() +
1135                    "': symbol multiply defined!");
1136 }
1137
1138 /// Loop over all of the linked values to compute type mappings.  For example,
1139 /// if we link "extern Foo *x" and "Foo *x = NULL", then we have two struct
1140 /// types 'Foo' but one got renamed when the module was loaded into the same
1141 /// LLVMContext.
1142 void ModuleLinker::computeTypeMapping() {
1143   for (GlobalValue &SGV : SrcM->globals()) {
1144     GlobalValue *DGV = getLinkedToGlobal(&SGV);
1145     if (!DGV)
1146       continue;
1147
1148     if (!DGV->hasAppendingLinkage() || !SGV.hasAppendingLinkage()) {
1149       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1150       continue;
1151     }
1152
1153     // Unify the element type of appending arrays.
1154     ArrayType *DAT = cast<ArrayType>(DGV->getType()->getElementType());
1155     ArrayType *SAT = cast<ArrayType>(SGV.getType()->getElementType());
1156     TypeMap.addTypeMapping(DAT->getElementType(), SAT->getElementType());
1157   }
1158
1159   for (GlobalValue &SGV : *SrcM) {
1160     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
1161       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1162   }
1163
1164   for (GlobalValue &SGV : SrcM->aliases()) {
1165     if (GlobalValue *DGV = getLinkedToGlobal(&SGV))
1166       TypeMap.addTypeMapping(DGV->getType(), SGV.getType());
1167   }
1168
1169   // Incorporate types by name, scanning all the types in the source module.
1170   // At this point, the destination module may have a type "%foo = { i32 }" for
1171   // example.  When the source module got loaded into the same LLVMContext, if
1172   // it had the same type, it would have been renamed to "%foo.42 = { i32 }".
1173   std::vector<StructType *> Types = SrcM->getIdentifiedStructTypes();
1174   for (StructType *ST : Types) {
1175     if (!ST->hasName())
1176       continue;
1177
1178     // Check to see if there is a dot in the name followed by a digit.
1179     size_t DotPos = ST->getName().rfind('.');
1180     if (DotPos == 0 || DotPos == StringRef::npos ||
1181         ST->getName().back() == '.' ||
1182         !isdigit(static_cast<unsigned char>(ST->getName()[DotPos + 1])))
1183       continue;
1184
1185     // Check to see if the destination module has a struct with the prefix name.
1186     StructType *DST = DstM->getTypeByName(ST->getName().substr(0, DotPos));
1187     if (!DST)
1188       continue;
1189
1190     // Don't use it if this actually came from the source module. They're in
1191     // the same LLVMContext after all. Also don't use it unless the type is
1192     // actually used in the destination module. This can happen in situations
1193     // like this:
1194     //
1195     //      Module A                         Module B
1196     //      --------                         --------
1197     //   %Z = type { %A }                %B = type { %C.1 }
1198     //   %A = type { %B.1, [7 x i8] }    %C.1 = type { i8* }
1199     //   %B.1 = type { %C }              %A.2 = type { %B.3, [5 x i8] }
1200     //   %C = type { i8* }               %B.3 = type { %C.1 }
1201     //
1202     // When we link Module B with Module A, the '%B' in Module B is
1203     // used. However, that would then use '%C.1'. But when we process '%C.1',
1204     // we prefer to take the '%C' version. So we are then left with both
1205     // '%C.1' and '%C' being used for the same types. This leads to some
1206     // variables using one type and some using the other.
1207     if (TypeMap.DstStructTypesSet.hasType(DST))
1208       TypeMap.addTypeMapping(DST, ST);
1209   }
1210
1211   // Now that we have discovered all of the type equivalences, get a body for
1212   // any 'opaque' types in the dest module that are now resolved.
1213   TypeMap.linkDefinedTypeBodies();
1214 }
1215
1216 static void upgradeGlobalArray(GlobalVariable *GV) {
1217   ArrayType *ATy = cast<ArrayType>(GV->getType()->getElementType());
1218   StructType *OldTy = cast<StructType>(ATy->getElementType());
1219   assert(OldTy->getNumElements() == 2 && "Expected to upgrade from 2 elements");
1220
1221   // Get the upgraded 3 element type.
1222   PointerType *VoidPtrTy = Type::getInt8Ty(GV->getContext())->getPointerTo();
1223   Type *Tys[3] = {OldTy->getElementType(0), OldTy->getElementType(1),
1224                   VoidPtrTy};
1225   StructType *NewTy = StructType::get(GV->getContext(), Tys, false);
1226
1227   // Build new constants with a null third field filled in.
1228   Constant *OldInitC = GV->getInitializer();
1229   ConstantArray *OldInit = dyn_cast<ConstantArray>(OldInitC);
1230   if (!OldInit && !isa<ConstantAggregateZero>(OldInitC))
1231     // Invalid initializer; give up.
1232     return;
1233   std::vector<Constant *> Initializers;
1234   if (OldInit && OldInit->getNumOperands()) {
1235     Value *Null = Constant::getNullValue(VoidPtrTy);
1236     for (Use &U : OldInit->operands()) {
1237       ConstantStruct *Init = cast<ConstantStruct>(U.get());
1238       Initializers.push_back(ConstantStruct::get(
1239           NewTy, Init->getOperand(0), Init->getOperand(1), Null, nullptr));
1240     }
1241   }
1242   assert(Initializers.size() == ATy->getNumElements() &&
1243          "Failed to copy all array elements");
1244
1245   // Replace the old GV with a new one.
1246   ATy = ArrayType::get(NewTy, Initializers.size());
1247   Constant *NewInit = ConstantArray::get(ATy, Initializers);
1248   GlobalVariable *NewGV = new GlobalVariable(
1249       *GV->getParent(), ATy, GV->isConstant(), GV->getLinkage(), NewInit, "",
1250       GV, GV->getThreadLocalMode(), GV->getType()->getAddressSpace(),
1251       GV->isExternallyInitialized());
1252   NewGV->copyAttributesFrom(GV);
1253   NewGV->takeName(GV);
1254   assert(GV->use_empty() && "program cannot use initializer list");
1255   GV->eraseFromParent();
1256 }
1257
1258 void ModuleLinker::upgradeMismatchedGlobalArray(StringRef Name) {
1259   // Look for the global arrays.
1260   auto *DstGV = dyn_cast_or_null<GlobalVariable>(DstM->getNamedValue(Name));
1261   if (!DstGV)
1262     return;
1263   auto *SrcGV = dyn_cast_or_null<GlobalVariable>(SrcM->getNamedValue(Name));
1264   if (!SrcGV)
1265     return;
1266
1267   // Check if the types already match.
1268   auto *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
1269   auto *SrcTy =
1270       cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
1271   if (DstTy == SrcTy)
1272     return;
1273
1274   // Grab the element types.  We can only upgrade an array of a two-field
1275   // struct.  Only bother if the other one has three-fields.
1276   auto *DstEltTy = cast<StructType>(DstTy->getElementType());
1277   auto *SrcEltTy = cast<StructType>(SrcTy->getElementType());
1278   if (DstEltTy->getNumElements() == 2 && SrcEltTy->getNumElements() == 3) {
1279     upgradeGlobalArray(DstGV);
1280     return;
1281   }
1282   if (DstEltTy->getNumElements() == 3 && SrcEltTy->getNumElements() == 2)
1283     upgradeGlobalArray(SrcGV);
1284
1285   // We can't upgrade any other differences.
1286 }
1287
1288 void ModuleLinker::upgradeMismatchedGlobals() {
1289   upgradeMismatchedGlobalArray("llvm.global_ctors");
1290   upgradeMismatchedGlobalArray("llvm.global_dtors");
1291 }
1292
1293 /// If there were any appending global variables, link them together now.
1294 /// Return true on error.
1295 bool ModuleLinker::linkAppendingVarProto(GlobalVariable *DstGV,
1296                                          const GlobalVariable *SrcGV) {
1297
1298   if (!SrcGV->hasAppendingLinkage() || !DstGV->hasAppendingLinkage())
1299     return emitError("Linking globals named '" + SrcGV->getName() +
1300            "': can only link appending global with another appending global!");
1301
1302   ArrayType *DstTy = cast<ArrayType>(DstGV->getType()->getElementType());
1303   ArrayType *SrcTy =
1304     cast<ArrayType>(TypeMap.get(SrcGV->getType()->getElementType()));
1305   Type *EltTy = DstTy->getElementType();
1306
1307   // Check to see that they two arrays agree on type.
1308   if (EltTy != SrcTy->getElementType())
1309     return emitError("Appending variables with different element types!");
1310   if (DstGV->isConstant() != SrcGV->isConstant())
1311     return emitError("Appending variables linked with different const'ness!");
1312
1313   if (DstGV->getAlignment() != SrcGV->getAlignment())
1314     return emitError(
1315              "Appending variables with different alignment need to be linked!");
1316
1317   if (DstGV->getVisibility() != SrcGV->getVisibility())
1318     return emitError(
1319             "Appending variables with different visibility need to be linked!");
1320
1321   if (DstGV->hasUnnamedAddr() != SrcGV->hasUnnamedAddr())
1322     return emitError(
1323         "Appending variables with different unnamed_addr need to be linked!");
1324
1325   if (StringRef(DstGV->getSection()) != SrcGV->getSection())
1326     return emitError(
1327           "Appending variables with different section name need to be linked!");
1328
1329   uint64_t NewSize = DstTy->getNumElements() + SrcTy->getNumElements();
1330   ArrayType *NewType = ArrayType::get(EltTy, NewSize);
1331
1332   // Create the new global variable.
1333   GlobalVariable *NG =
1334     new GlobalVariable(*DstGV->getParent(), NewType, SrcGV->isConstant(),
1335                        DstGV->getLinkage(), /*init*/nullptr, /*name*/"", DstGV,
1336                        DstGV->getThreadLocalMode(),
1337                        DstGV->getType()->getAddressSpace());
1338
1339   // Propagate alignment, visibility and section info.
1340   copyGVAttributes(NG, DstGV);
1341
1342   AppendingVarInfo AVI;
1343   AVI.NewGV = NG;
1344   AVI.DstInit = DstGV->getInitializer();
1345   AVI.SrcInit = SrcGV->getInitializer();
1346   AppendingVars.push_back(AVI);
1347
1348   // Replace any uses of the two global variables with uses of the new
1349   // global.
1350   ValueMap[SrcGV] = ConstantExpr::getBitCast(NG, TypeMap.get(SrcGV->getType()));
1351
1352   DstGV->replaceAllUsesWith(ConstantExpr::getBitCast(NG, DstGV->getType()));
1353   DstGV->eraseFromParent();
1354
1355   // Track the source variable so we don't try to link it.
1356   DoNotLinkFromSource.insert(SrcGV);
1357
1358   return false;
1359 }
1360
1361 bool ModuleLinker::linkGlobalValueProto(GlobalValue *SGV) {
1362   GlobalValue *DGV = getLinkedToGlobal(SGV);
1363
1364   // Handle the ultra special appending linkage case first.
1365   assert(!DGV || SGV->hasAppendingLinkage() == DGV->hasAppendingLinkage());
1366   if (SGV->hasAppendingLinkage() && isPerformingImport()) {
1367     // Don't want to append to global_ctors list, for example, when we
1368     // are importing for ThinLTO, otherwise the global ctors and dtors
1369     // get executed multiple times for local variables (the latter causing
1370     // double frees).
1371     DoNotLinkFromSource.insert(SGV);
1372     return false;
1373   }
1374   if (DGV && DGV->hasAppendingLinkage())
1375     return linkAppendingVarProto(cast<GlobalVariable>(DGV),
1376                                  cast<GlobalVariable>(SGV));
1377
1378   bool LinkFromSrc = true;
1379   Comdat *C = nullptr;
1380   bool HasUnnamedAddr = SGV->hasUnnamedAddr();
1381
1382   if (const Comdat *SC = SGV->getComdat()) {
1383     Comdat::SelectionKind SK;
1384     std::tie(SK, LinkFromSrc) = ComdatsChosen[SC];
1385     C = DstM->getOrInsertComdat(SC->getName());
1386     C->setSelectionKind(SK);
1387   } else if (DGV) {
1388     if (shouldLinkFromSource(LinkFromSrc, *DGV, *SGV))
1389       return true;
1390   }
1391
1392   if (!LinkFromSrc) {
1393     // Track the source global so that we don't attempt to copy it over when
1394     // processing global initializers.
1395     DoNotLinkFromSource.insert(SGV);
1396
1397     if (DGV)
1398       // Make sure to remember this mapping.
1399       ValueMap[SGV] =
1400           ConstantExpr::getBitCast(DGV, TypeMap.get(SGV->getType()));
1401   }
1402
1403   if (DGV)
1404     HasUnnamedAddr = HasUnnamedAddr && DGV->hasUnnamedAddr();
1405
1406   if (!LinkFromSrc && !DGV)
1407     return false;
1408
1409   GlobalValue *NewGV;
1410   if (!LinkFromSrc) {
1411     NewGV = DGV;
1412     // When linking from source we setVisibility from copyGlobalValueProto.
1413     setVisibility(NewGV, SGV, DGV);
1414   } else {
1415     // If the GV is to be lazily linked, don't create it just yet.
1416     // The ValueMaterializerTy will deal with creating it if it's used.
1417     if (!DGV && !shouldOverrideFromSrc() && SGV != ImportFunction &&
1418         (SGV->hasLocalLinkage() || SGV->hasLinkOnceLinkage() ||
1419          SGV->hasAvailableExternallyLinkage())) {
1420       DoNotLinkFromSource.insert(SGV);
1421       return false;
1422     }
1423
1424     // When we only want to link in unresolved dependencies, blacklist
1425     // the symbol unless unless DestM has a matching declaration (DGV).
1426     if (shouldLinkOnlyNeeded() && !(DGV && DGV->isDeclaration())) {
1427       DoNotLinkFromSource.insert(SGV);
1428       return false;
1429     }
1430
1431     NewGV = copyGlobalValueProto(TypeMap, SGV, DGV);
1432
1433     if (isPerformingImport() && !doImportAsDefinition(SGV))
1434       DoNotLinkFromSource.insert(SGV);
1435   }
1436
1437   NewGV->setUnnamedAddr(HasUnnamedAddr);
1438
1439   if (auto *NewGO = dyn_cast<GlobalObject>(NewGV)) {
1440     if (C)
1441       NewGO->setComdat(C);
1442
1443     if (DGV && DGV->hasCommonLinkage() && SGV->hasCommonLinkage())
1444       NewGO->setAlignment(std::max(DGV->getAlignment(), SGV->getAlignment()));
1445   }
1446
1447   if (auto *NewGVar = dyn_cast<GlobalVariable>(NewGV)) {
1448     auto *DGVar = dyn_cast_or_null<GlobalVariable>(DGV);
1449     auto *SGVar = dyn_cast<GlobalVariable>(SGV);
1450     if (DGVar && SGVar && DGVar->isDeclaration() && SGVar->isDeclaration() &&
1451         (!DGVar->isConstant() || !SGVar->isConstant()))
1452       NewGVar->setConstant(false);
1453   }
1454
1455   // Make sure to remember this mapping.
1456   if (NewGV != DGV) {
1457     if (DGV) {
1458       DGV->replaceAllUsesWith(ConstantExpr::getBitCast(NewGV, DGV->getType()));
1459       DGV->eraseFromParent();
1460     }
1461     ValueMap[SGV] = NewGV;
1462   }
1463
1464   return false;
1465 }
1466
1467 static void getArrayElements(const Constant *C,
1468                              SmallVectorImpl<Constant *> &Dest) {
1469   unsigned NumElements = cast<ArrayType>(C->getType())->getNumElements();
1470
1471   for (unsigned i = 0; i != NumElements; ++i)
1472     Dest.push_back(C->getAggregateElement(i));
1473 }
1474
1475 void ModuleLinker::linkAppendingVarInit(const AppendingVarInfo &AVI) {
1476   // Merge the initializer.
1477   SmallVector<Constant *, 16> DstElements;
1478   getArrayElements(AVI.DstInit, DstElements);
1479
1480   SmallVector<Constant *, 16> SrcElements;
1481   getArrayElements(AVI.SrcInit, SrcElements);
1482
1483   ArrayType *NewType = cast<ArrayType>(AVI.NewGV->getType()->getElementType());
1484
1485   StringRef Name = AVI.NewGV->getName();
1486   bool IsNewStructor =
1487       (Name == "llvm.global_ctors" || Name == "llvm.global_dtors") &&
1488       cast<StructType>(NewType->getElementType())->getNumElements() == 3;
1489
1490   for (auto *V : SrcElements) {
1491     if (IsNewStructor) {
1492       Constant *Key = V->getAggregateElement(2);
1493       if (DoNotLinkFromSource.count(Key))
1494         continue;
1495     }
1496     DstElements.push_back(
1497         MapValue(V, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1498   }
1499   if (IsNewStructor) {
1500     NewType = ArrayType::get(NewType->getElementType(), DstElements.size());
1501     AVI.NewGV->mutateType(PointerType::get(NewType, 0));
1502   }
1503
1504   AVI.NewGV->setInitializer(ConstantArray::get(NewType, DstElements));
1505 }
1506
1507 /// Update the initializers in the Dest module now that all globals that may be
1508 /// referenced are in Dest.
1509 void ModuleLinker::linkGlobalInit(GlobalVariable &Dst, GlobalVariable &Src) {
1510   // Figure out what the initializer looks like in the dest module.
1511   Dst.setInitializer(MapValue(Src.getInitializer(), ValueMap,
1512                               RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1513 }
1514
1515 /// Copy the source function over into the dest function and fix up references
1516 /// to values. At this point we know that Dest is an external function, and
1517 /// that Src is not.
1518 bool ModuleLinker::linkFunctionBody(Function &Dst, Function &Src) {
1519   assert(Dst.isDeclaration() && !Src.isDeclaration());
1520
1521   // Materialize if needed.
1522   if (std::error_code EC = Src.materialize())
1523     return emitError(EC.message());
1524
1525   // Link in the prefix data.
1526   if (Src.hasPrefixData())
1527     Dst.setPrefixData(MapValue(Src.getPrefixData(), ValueMap,
1528                                RF_MoveDistinctMDs, &TypeMap, &ValMaterializer));
1529
1530   // Link in the prologue data.
1531   if (Src.hasPrologueData())
1532     Dst.setPrologueData(MapValue(Src.getPrologueData(), ValueMap,
1533                                  RF_MoveDistinctMDs, &TypeMap,
1534                                  &ValMaterializer));
1535
1536   // Link in the personality function.
1537   if (Src.hasPersonalityFn())
1538     Dst.setPersonalityFn(MapValue(Src.getPersonalityFn(), ValueMap,
1539                                   RF_MoveDistinctMDs, &TypeMap,
1540                                   &ValMaterializer));
1541
1542   // Go through and convert function arguments over, remembering the mapping.
1543   Function::arg_iterator DI = Dst.arg_begin();
1544   for (Argument &Arg : Src.args()) {
1545     DI->setName(Arg.getName());  // Copy the name over.
1546
1547     // Add a mapping to our mapping.
1548     ValueMap[&Arg] = &*DI;
1549     ++DI;
1550   }
1551
1552   // Copy over the metadata attachments.
1553   SmallVector<std::pair<unsigned, MDNode *>, 8> MDs;
1554   Src.getAllMetadata(MDs);
1555   for (const auto &I : MDs)
1556     Dst.setMetadata(I.first, MapMetadata(I.second, ValueMap, RF_MoveDistinctMDs,
1557                                          &TypeMap, &ValMaterializer));
1558
1559   // Splice the body of the source function into the dest function.
1560   Dst.getBasicBlockList().splice(Dst.end(), Src.getBasicBlockList());
1561
1562   // At this point, all of the instructions and values of the function are now
1563   // copied over.  The only problem is that they are still referencing values in
1564   // the Source function as operands.  Loop through all of the operands of the
1565   // functions and patch them up to point to the local versions.
1566   for (BasicBlock &BB : Dst)
1567     for (Instruction &I : BB)
1568       RemapInstruction(&I, ValueMap,
1569                        RF_IgnoreMissingEntries | RF_MoveDistinctMDs, &TypeMap,
1570                        &ValMaterializer);
1571
1572   // There is no need to map the arguments anymore.
1573   for (Argument &Arg : Src.args())
1574     ValueMap.erase(&Arg);
1575
1576   Src.dematerialize();
1577   return false;
1578 }
1579
1580 void ModuleLinker::linkAliasBody(GlobalAlias &Dst, GlobalAlias &Src) {
1581   Constant *Aliasee = Src.getAliasee();
1582   Constant *Val = MapValue(Aliasee, ValueMap, RF_MoveDistinctMDs, &TypeMap,
1583                            &ValMaterializer);
1584   Dst.setAliasee(Val);
1585 }
1586
1587 bool ModuleLinker::linkGlobalValueBody(GlobalValue &Src) {
1588   Value *Dst = ValueMap[&Src];
1589   assert(Dst);
1590   if (shouldInternalizeLinkedSymbols())
1591     if (auto *DGV = dyn_cast<GlobalValue>(Dst))
1592       DGV->setLinkage(GlobalValue::InternalLinkage);
1593   if (auto *F = dyn_cast<Function>(&Src))
1594     return linkFunctionBody(cast<Function>(*Dst), *F);
1595   if (auto *GVar = dyn_cast<GlobalVariable>(&Src)) {
1596     linkGlobalInit(cast<GlobalVariable>(*Dst), *GVar);
1597     return false;
1598   }
1599   linkAliasBody(cast<GlobalAlias>(*Dst), cast<GlobalAlias>(Src));
1600   return false;
1601 }
1602
1603 /// Insert all of the named MDNodes in Src into the Dest module.
1604 void ModuleLinker::linkNamedMDNodes() {
1605   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1606   for (const NamedMDNode &NMD : SrcM->named_metadata()) {
1607     // Don't link module flags here. Do them separately.
1608     if (&NMD == SrcModFlags)
1609       continue;
1610     NamedMDNode *DestNMD = DstM->getOrInsertNamedMetadata(NMD.getName());
1611     // Add Src elements into Dest node.
1612     for (const MDNode *op : NMD.operands())
1613       DestNMD->addOperand(MapMetadata(op, ValueMap, RF_MoveDistinctMDs,
1614                                       &TypeMap, &ValMaterializer));
1615   }
1616 }
1617
1618 /// Merge the linker flags in Src into the Dest module.
1619 bool ModuleLinker::linkModuleFlagsMetadata() {
1620   // If the source module has no module flags, we are done.
1621   const NamedMDNode *SrcModFlags = SrcM->getModuleFlagsMetadata();
1622   if (!SrcModFlags) return false;
1623
1624   // If the destination module doesn't have module flags yet, then just copy
1625   // over the source module's flags.
1626   NamedMDNode *DstModFlags = DstM->getOrInsertModuleFlagsMetadata();
1627   if (DstModFlags->getNumOperands() == 0) {
1628     for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I)
1629       DstModFlags->addOperand(SrcModFlags->getOperand(I));
1630
1631     return false;
1632   }
1633
1634   // First build a map of the existing module flags and requirements.
1635   DenseMap<MDString *, std::pair<MDNode *, unsigned>> Flags;
1636   SmallSetVector<MDNode*, 16> Requirements;
1637   for (unsigned I = 0, E = DstModFlags->getNumOperands(); I != E; ++I) {
1638     MDNode *Op = DstModFlags->getOperand(I);
1639     ConstantInt *Behavior = mdconst::extract<ConstantInt>(Op->getOperand(0));
1640     MDString *ID = cast<MDString>(Op->getOperand(1));
1641
1642     if (Behavior->getZExtValue() == Module::Require) {
1643       Requirements.insert(cast<MDNode>(Op->getOperand(2)));
1644     } else {
1645       Flags[ID] = std::make_pair(Op, I);
1646     }
1647   }
1648
1649   // Merge in the flags from the source module, and also collect its set of
1650   // requirements.
1651   bool HasErr = false;
1652   for (unsigned I = 0, E = SrcModFlags->getNumOperands(); I != E; ++I) {
1653     MDNode *SrcOp = SrcModFlags->getOperand(I);
1654     ConstantInt *SrcBehavior =
1655         mdconst::extract<ConstantInt>(SrcOp->getOperand(0));
1656     MDString *ID = cast<MDString>(SrcOp->getOperand(1));
1657     MDNode *DstOp;
1658     unsigned DstIndex;
1659     std::tie(DstOp, DstIndex) = Flags.lookup(ID);
1660     unsigned SrcBehaviorValue = SrcBehavior->getZExtValue();
1661
1662     // If this is a requirement, add it and continue.
1663     if (SrcBehaviorValue == Module::Require) {
1664       // If the destination module does not already have this requirement, add
1665       // it.
1666       if (Requirements.insert(cast<MDNode>(SrcOp->getOperand(2)))) {
1667         DstModFlags->addOperand(SrcOp);
1668       }
1669       continue;
1670     }
1671
1672     // If there is no existing flag with this ID, just add it.
1673     if (!DstOp) {
1674       Flags[ID] = std::make_pair(SrcOp, DstModFlags->getNumOperands());
1675       DstModFlags->addOperand(SrcOp);
1676       continue;
1677     }
1678
1679     // Otherwise, perform a merge.
1680     ConstantInt *DstBehavior =
1681         mdconst::extract<ConstantInt>(DstOp->getOperand(0));
1682     unsigned DstBehaviorValue = DstBehavior->getZExtValue();
1683
1684     // If either flag has override behavior, handle it first.
1685     if (DstBehaviorValue == Module::Override) {
1686       // Diagnose inconsistent flags which both have override behavior.
1687       if (SrcBehaviorValue == Module::Override &&
1688           SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1689         HasErr |= emitError("linking module flags '" + ID->getString() +
1690                             "': IDs have conflicting override values");
1691       }
1692       continue;
1693     } else if (SrcBehaviorValue == Module::Override) {
1694       // Update the destination flag to that of the source.
1695       DstModFlags->setOperand(DstIndex, SrcOp);
1696       Flags[ID].first = SrcOp;
1697       continue;
1698     }
1699
1700     // Diagnose inconsistent merge behavior types.
1701     if (SrcBehaviorValue != DstBehaviorValue) {
1702       HasErr |= emitError("linking module flags '" + ID->getString() +
1703                           "': IDs have conflicting behaviors");
1704       continue;
1705     }
1706
1707     auto replaceDstValue = [&](MDNode *New) {
1708       Metadata *FlagOps[] = {DstOp->getOperand(0), ID, New};
1709       MDNode *Flag = MDNode::get(DstM->getContext(), FlagOps);
1710       DstModFlags->setOperand(DstIndex, Flag);
1711       Flags[ID].first = Flag;
1712     };
1713
1714     // Perform the merge for standard behavior types.
1715     switch (SrcBehaviorValue) {
1716     case Module::Require:
1717     case Module::Override: llvm_unreachable("not possible");
1718     case Module::Error: {
1719       // Emit an error if the values differ.
1720       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1721         HasErr |= emitError("linking module flags '" + ID->getString() +
1722                             "': IDs have conflicting values");
1723       }
1724       continue;
1725     }
1726     case Module::Warning: {
1727       // Emit a warning if the values differ.
1728       if (SrcOp->getOperand(2) != DstOp->getOperand(2)) {
1729         emitWarning("linking module flags '" + ID->getString() +
1730                     "': IDs have conflicting values");
1731       }
1732       continue;
1733     }
1734     case Module::Append: {
1735       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1736       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1737       SmallVector<Metadata *, 8> MDs;
1738       MDs.reserve(DstValue->getNumOperands() + SrcValue->getNumOperands());
1739       MDs.append(DstValue->op_begin(), DstValue->op_end());
1740       MDs.append(SrcValue->op_begin(), SrcValue->op_end());
1741
1742       replaceDstValue(MDNode::get(DstM->getContext(), MDs));
1743       break;
1744     }
1745     case Module::AppendUnique: {
1746       SmallSetVector<Metadata *, 16> Elts;
1747       MDNode *DstValue = cast<MDNode>(DstOp->getOperand(2));
1748       MDNode *SrcValue = cast<MDNode>(SrcOp->getOperand(2));
1749       Elts.insert(DstValue->op_begin(), DstValue->op_end());
1750       Elts.insert(SrcValue->op_begin(), SrcValue->op_end());
1751
1752       replaceDstValue(MDNode::get(DstM->getContext(),
1753                                   makeArrayRef(Elts.begin(), Elts.end())));
1754       break;
1755     }
1756     }
1757   }
1758
1759   // Check all of the requirements.
1760   for (unsigned I = 0, E = Requirements.size(); I != E; ++I) {
1761     MDNode *Requirement = Requirements[I];
1762     MDString *Flag = cast<MDString>(Requirement->getOperand(0));
1763     Metadata *ReqValue = Requirement->getOperand(1);
1764
1765     MDNode *Op = Flags[Flag].first;
1766     if (!Op || Op->getOperand(2) != ReqValue) {
1767       HasErr |= emitError("linking module flags '" + Flag->getString() +
1768                           "': does not have the required value");
1769       continue;
1770     }
1771   }
1772
1773   return HasErr;
1774 }
1775
1776 // This function returns true if the triples match.
1777 static bool triplesMatch(const Triple &T0, const Triple &T1) {
1778   // If vendor is apple, ignore the version number.
1779   if (T0.getVendor() == Triple::Apple)
1780     return T0.getArch() == T1.getArch() &&
1781            T0.getSubArch() == T1.getSubArch() &&
1782            T0.getVendor() == T1.getVendor() &&
1783            T0.getOS() == T1.getOS();
1784
1785   return T0 == T1;
1786 }
1787
1788 // This function returns the merged triple.
1789 static std::string mergeTriples(const Triple &SrcTriple, const Triple &DstTriple) {
1790   // If vendor is apple, pick the triple with the larger version number.
1791   if (SrcTriple.getVendor() == Triple::Apple)
1792     if (DstTriple.isOSVersionLT(SrcTriple))
1793       return SrcTriple.str();
1794
1795   return DstTriple.str();
1796 }
1797
1798 bool ModuleLinker::run() {
1799   assert(DstM && "Null destination module");
1800   assert(SrcM && "Null source module");
1801
1802   // Inherit the target data from the source module if the destination module
1803   // doesn't have one already.
1804   if (DstM->getDataLayout().isDefault())
1805     DstM->setDataLayout(SrcM->getDataLayout());
1806
1807   if (SrcM->getDataLayout() != DstM->getDataLayout()) {
1808     emitWarning("Linking two modules of different data layouts: '" +
1809                 SrcM->getModuleIdentifier() + "' is '" +
1810                 SrcM->getDataLayoutStr() + "' whereas '" +
1811                 DstM->getModuleIdentifier() + "' is '" +
1812                 DstM->getDataLayoutStr() + "'\n");
1813   }
1814
1815   // Copy the target triple from the source to dest if the dest's is empty.
1816   if (DstM->getTargetTriple().empty() && !SrcM->getTargetTriple().empty())
1817     DstM->setTargetTriple(SrcM->getTargetTriple());
1818
1819   Triple SrcTriple(SrcM->getTargetTriple()), DstTriple(DstM->getTargetTriple());
1820
1821   if (!SrcM->getTargetTriple().empty() && !triplesMatch(SrcTriple, DstTriple))
1822     emitWarning("Linking two modules of different target triples: " +
1823                 SrcM->getModuleIdentifier() + "' is '" +
1824                 SrcM->getTargetTriple() + "' whereas '" +
1825                 DstM->getModuleIdentifier() + "' is '" +
1826                 DstM->getTargetTriple() + "'\n");
1827
1828   DstM->setTargetTriple(mergeTriples(SrcTriple, DstTriple));
1829
1830   // Append the module inline asm string.
1831   if (!SrcM->getModuleInlineAsm().empty()) {
1832     if (DstM->getModuleInlineAsm().empty())
1833       DstM->setModuleInlineAsm(SrcM->getModuleInlineAsm());
1834     else
1835       DstM->setModuleInlineAsm(DstM->getModuleInlineAsm()+"\n"+
1836                                SrcM->getModuleInlineAsm());
1837   }
1838
1839   // Loop over all of the linked values to compute type mappings.
1840   computeTypeMapping();
1841
1842   ComdatsChosen.clear();
1843   for (const auto &SMEC : SrcM->getComdatSymbolTable()) {
1844     const Comdat &C = SMEC.getValue();
1845     if (ComdatsChosen.count(&C))
1846       continue;
1847     Comdat::SelectionKind SK;
1848     bool LinkFromSrc;
1849     if (getComdatResult(&C, SK, LinkFromSrc))
1850       return true;
1851     ComdatsChosen[&C] = std::make_pair(SK, LinkFromSrc);
1852   }
1853
1854   // Upgrade mismatched global arrays.
1855   upgradeMismatchedGlobals();
1856
1857   // Insert all of the globals in src into the DstM module... without linking
1858   // initializers (which could refer to functions not yet mapped over).
1859   for (GlobalVariable &GV : SrcM->globals())
1860     if (linkGlobalValueProto(&GV))
1861       return true;
1862
1863   // Link the functions together between the two modules, without doing function
1864   // bodies... this just adds external function prototypes to the DstM
1865   // function...  We do this so that when we begin processing function bodies,
1866   // all of the global values that may be referenced are available in our
1867   // ValueMap.
1868   for (Function &F :*SrcM)
1869     if (linkGlobalValueProto(&F))
1870       return true;
1871
1872   // If there were any aliases, link them now.
1873   for (GlobalAlias &GA : SrcM->aliases())
1874     if (linkGlobalValueProto(&GA))
1875       return true;
1876
1877   for (const AppendingVarInfo &AppendingVar : AppendingVars)
1878     linkAppendingVarInit(AppendingVar);
1879
1880   for (const auto &Entry : DstM->getComdatSymbolTable()) {
1881     const Comdat &C = Entry.getValue();
1882     if (C.getSelectionKind() == Comdat::Any)
1883       continue;
1884     const GlobalValue *GV = SrcM->getNamedValue(C.getName());
1885     if (GV)
1886       MapValue(GV, ValueMap, RF_MoveDistinctMDs, &TypeMap, &ValMaterializer);
1887   }
1888
1889   // Link in the function bodies that are defined in the source module into
1890   // DstM.
1891   for (Function &SF : *SrcM) {
1892     // Skip if no body (function is external).
1893     if (SF.isDeclaration())
1894       continue;
1895
1896     // Skip if not linking from source.
1897     if (DoNotLinkFromSource.count(&SF))
1898       continue;
1899
1900     if (linkGlobalValueBody(SF))
1901       return true;
1902   }
1903
1904   // Resolve all uses of aliases with aliasees.
1905   for (GlobalAlias &Src : SrcM->aliases()) {
1906     if (DoNotLinkFromSource.count(&Src))
1907       continue;
1908     linkGlobalValueBody(Src);
1909   }
1910
1911   // Update the initializers in the DstM module now that all globals that may
1912   // be referenced are in DstM.
1913   for (GlobalVariable &Src : SrcM->globals()) {
1914     // Only process initialized GV's or ones not already in dest.
1915     if (!Src.hasInitializer() || DoNotLinkFromSource.count(&Src))
1916       continue;
1917     linkGlobalValueBody(Src);
1918   }
1919
1920   // Process vector of lazily linked in functions.
1921   while (!LazilyLinkGlobalValues.empty()) {
1922     GlobalValue *SGV = LazilyLinkGlobalValues.back();
1923     LazilyLinkGlobalValues.pop_back();
1924     if (isPerformingImport() && !doImportAsDefinition(SGV))
1925       continue;
1926
1927     // Skip declarations that ValueMaterializer may have created in
1928     // case we link in only some of SrcM.
1929     if (shouldLinkOnlyNeeded() && SGV->isDeclaration())
1930       continue;
1931
1932     assert(!SGV->isDeclaration() && "users should not pass down decls");
1933     if (linkGlobalValueBody(*SGV))
1934       return true;
1935   }
1936
1937   // Note that we are done linking global value bodies. This prevents
1938   // metadata linking from creating new references.
1939   DoneLinkingBodies = true;
1940
1941   // Remap all of the named MDNodes in Src into the DstM module. We do this
1942   // after linking GlobalValues so that MDNodes that reference GlobalValues
1943   // are properly remapped.
1944   linkNamedMDNodes();
1945
1946   // Merge the module flags into the DstM module.
1947   if (linkModuleFlagsMetadata())
1948     return true;
1949
1950   return false;
1951 }
1952
1953 Linker::StructTypeKeyInfo::KeyTy::KeyTy(ArrayRef<Type *> E, bool P)
1954     : ETypes(E), IsPacked(P) {}
1955
1956 Linker::StructTypeKeyInfo::KeyTy::KeyTy(const StructType *ST)
1957     : ETypes(ST->elements()), IsPacked(ST->isPacked()) {}
1958
1959 bool Linker::StructTypeKeyInfo::KeyTy::operator==(const KeyTy &That) const {
1960   if (IsPacked != That.IsPacked)
1961     return false;
1962   if (ETypes != That.ETypes)
1963     return false;
1964   return true;
1965 }
1966
1967 bool Linker::StructTypeKeyInfo::KeyTy::operator!=(const KeyTy &That) const {
1968   return !this->operator==(That);
1969 }
1970
1971 StructType *Linker::StructTypeKeyInfo::getEmptyKey() {
1972   return DenseMapInfo<StructType *>::getEmptyKey();
1973 }
1974
1975 StructType *Linker::StructTypeKeyInfo::getTombstoneKey() {
1976   return DenseMapInfo<StructType *>::getTombstoneKey();
1977 }
1978
1979 unsigned Linker::StructTypeKeyInfo::getHashValue(const KeyTy &Key) {
1980   return hash_combine(hash_combine_range(Key.ETypes.begin(), Key.ETypes.end()),
1981                       Key.IsPacked);
1982 }
1983
1984 unsigned Linker::StructTypeKeyInfo::getHashValue(const StructType *ST) {
1985   return getHashValue(KeyTy(ST));
1986 }
1987
1988 bool Linker::StructTypeKeyInfo::isEqual(const KeyTy &LHS,
1989                                         const StructType *RHS) {
1990   if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1991     return false;
1992   return LHS == KeyTy(RHS);
1993 }
1994
1995 bool Linker::StructTypeKeyInfo::isEqual(const StructType *LHS,
1996                                         const StructType *RHS) {
1997   if (RHS == getEmptyKey())
1998     return LHS == getEmptyKey();
1999
2000   if (RHS == getTombstoneKey())
2001     return LHS == getTombstoneKey();
2002
2003   return KeyTy(LHS) == KeyTy(RHS);
2004 }
2005
2006 void Linker::IdentifiedStructTypeSet::addNonOpaque(StructType *Ty) {
2007   assert(!Ty->isOpaque());
2008   NonOpaqueStructTypes.insert(Ty);
2009 }
2010
2011 void Linker::IdentifiedStructTypeSet::switchToNonOpaque(StructType *Ty) {
2012   assert(!Ty->isOpaque());
2013   NonOpaqueStructTypes.insert(Ty);
2014   bool Removed = OpaqueStructTypes.erase(Ty);
2015   (void)Removed;
2016   assert(Removed);
2017 }
2018
2019 void Linker::IdentifiedStructTypeSet::addOpaque(StructType *Ty) {
2020   assert(Ty->isOpaque());
2021   OpaqueStructTypes.insert(Ty);
2022 }
2023
2024 StructType *
2025 Linker::IdentifiedStructTypeSet::findNonOpaque(ArrayRef<Type *> ETypes,
2026                                                bool IsPacked) {
2027   Linker::StructTypeKeyInfo::KeyTy Key(ETypes, IsPacked);
2028   auto I = NonOpaqueStructTypes.find_as(Key);
2029   if (I == NonOpaqueStructTypes.end())
2030     return nullptr;
2031   return *I;
2032 }
2033
2034 bool Linker::IdentifiedStructTypeSet::hasType(StructType *Ty) {
2035   if (Ty->isOpaque())
2036     return OpaqueStructTypes.count(Ty);
2037   auto I = NonOpaqueStructTypes.find(Ty);
2038   if (I == NonOpaqueStructTypes.end())
2039     return false;
2040   return *I == Ty;
2041 }
2042
2043 void Linker::init(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
2044   this->Composite = M;
2045   this->DiagnosticHandler = DiagnosticHandler;
2046
2047   TypeFinder StructTypes;
2048   StructTypes.run(*M, true);
2049   for (StructType *Ty : StructTypes) {
2050     if (Ty->isOpaque())
2051       IdentifiedStructTypes.addOpaque(Ty);
2052     else
2053       IdentifiedStructTypes.addNonOpaque(Ty);
2054   }
2055 }
2056
2057 Linker::Linker(Module *M, DiagnosticHandlerFunction DiagnosticHandler) {
2058   init(M, DiagnosticHandler);
2059 }
2060
2061 Linker::Linker(Module *M) {
2062   init(M, [this](const DiagnosticInfo &DI) {
2063     Composite->getContext().diagnose(DI);
2064   });
2065 }
2066
2067 void Linker::deleteModule() {
2068   delete Composite;
2069   Composite = nullptr;
2070 }
2071
2072 bool Linker::linkInModule(Module *Src, unsigned Flags, FunctionInfoIndex *Index,
2073                           Function *FuncToImport) {
2074   ModuleLinker TheLinker(Composite, IdentifiedStructTypes, Src,
2075                          DiagnosticHandler, Flags, Index, FuncToImport);
2076   bool RetCode = TheLinker.run();
2077   Composite->dropTriviallyDeadConstantArrays();
2078   return RetCode;
2079 }
2080
2081 void Linker::setModule(Module *Dst) {
2082   init(Dst, DiagnosticHandler);
2083 }
2084
2085 //===----------------------------------------------------------------------===//
2086 // LinkModules entrypoint.
2087 //===----------------------------------------------------------------------===//
2088
2089 /// This function links two modules together, with the resulting Dest module
2090 /// modified to be the composite of the two input modules. If an error occurs,
2091 /// true is returned and ErrorMsg (if not null) is set to indicate the problem.
2092 /// Upon failure, the Dest module could be in a modified state, and shouldn't be
2093 /// relied on to be consistent.
2094 bool Linker::LinkModules(Module *Dest, Module *Src,
2095                          DiagnosticHandlerFunction DiagnosticHandler,
2096                          unsigned Flags) {
2097   Linker L(Dest, DiagnosticHandler);
2098   return L.linkInModule(Src, Flags);
2099 }
2100
2101 bool Linker::LinkModules(Module *Dest, Module *Src, unsigned Flags) {
2102   Linker L(Dest);
2103   return L.linkInModule(Src, Flags);
2104 }
2105
2106 //===----------------------------------------------------------------------===//
2107 // C API.
2108 //===----------------------------------------------------------------------===//
2109
2110 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
2111                          LLVMLinkerMode Unused, char **OutMessages) {
2112   Module *D = unwrap(Dest);
2113   std::string Message;
2114   raw_string_ostream Stream(Message);
2115   DiagnosticPrinterRawOStream DP(Stream);
2116
2117   LLVMBool Result = Linker::LinkModules(
2118       D, unwrap(Src), [&](const DiagnosticInfo &DI) { DI.print(DP); });
2119
2120   if (OutMessages && Result) {
2121     Stream.flush();
2122     *OutMessages = strdup(Message.c_str());
2123   }
2124   return Result;
2125 }