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