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