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