lib/Linker/LinkModules.cpp

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