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